Overview
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 via HTTPS to a specific URL.
You can also create webhooks using the API.
You can set up webhooks to receive notifications in the following cases:
- Job status updates. Every time a job changes its status.
- Order status updates. When a new order has been completed — successfully or not.
Create webhooks
- Open the console and click the upper right corner → 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.
Test webhooks
- Open the console and click the upper right corner → Webhooks.
- Click
→ Test → Send test event.
A message will be sent to the URL endpoint.
Manage webhooks
- Open the console and click the upper right corner → Webhooks.
- Click
to edit or delete a webhook.