Skip to main content

How Webhooks Work

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

Suppose you are a seller who wishes to track the orders placed by your customers. One approach would be to check new orders 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 order creation event. Therefore, the moment someone places an order, you'll be notified. Thus, you won't have to perform API calls recurringly.

Traditional API Hits vs Webhook Subscription

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
    • Authentication is recommended but it's not mandatory
  • 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 product, deletion of an order, and many more.

  • Webhook Subscription: A list of events for which you have chosen to receive notifications on your app or server.

  • Payload: It is the data related to the event you've subscribed to. 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.