A webhook is a method for sending event notifications from one application to another. When something happens in a source system indicated by an event, the webhook transmits an event notification through HTTPS to a specific URL.
You can set up webhooks to receive notifications for order status updates. You’ll receive a notification when a new order has been completed — successfully or not.- Open the console.
- In the upper right corner, click your workspace name → Webhooks.
- Click Create webhook.
- Configure the webhook parameters:
- Name. A custom webhook name.
- URL endpoint. A unique URL where the webhook will send the message (HTTPS is required).
- Secret. A signature that will be part of the HTTPS header. If no secret is added, there will be no signature header.
- Events. The event types that trigger your webhook.
- Status. Whether the webhook should be active.
- Click Save.
- Open the console.
- In the upper right corner, click your workspace name → Webhooks.
- Click → Test → Send test event.
A message will be sent to the URL endpoint.
- Open the console.
- In the upper right corner, click your workspace name → Webhooks.
- Click to edit or delete a webhook.