How Webhook Works?

Before you begin with webhooks, it's important to understand the need for webhooks in the first place.

Suppose you are a company that wishes to track image uploads by people in your company. One approach would be to check new images in the app, at regular intervals. However, this method is repetitive and may not yield results in real-time.

Instead, a webhook can be configured to listen to an image upload event. Therefore, the moment someone uploads an image, you'll be notified. Thus, you won't have to perform API calls recurringly.

Webhook Terminologies

Before configuring a webhook, let's understand the terminologies used in a typical webhook system.

• Webhook URL: Also known as a webhook endpoint, it's the URL on which you want us to send the webhook data (payload). Please ensure that your webhook URL adheres to the following criteria:

  • It should be an HTTPS URL
  • It should be a publicly accessible URL

• Event: It is the action performed by your staff and customers. We support notifications (webhooks) for multiple types of events, such as the creation of a folder, the deletion of a file, and many more.

• Payload: It is the data related to the event which we will send to your API. Generally, the payload which we send to your webhook URL is in JSON format and you can utilize it as per your business use case.