Webhooks

Send event notifications with webhooks.


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

  1. Click the upper right corner → Webhooks.
  2. Click Create Webhook.
  3. 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.
  4. Click Save.

Test webhooks

  1. Click the upper right corner → Webhooks.
  2. Click Menu iconTestSend Test Event.

A message will be sent to the URL endpoint.

Manage webhooks

  1. Click the upper right corner → Webhooks.
  2. Click Menu icon to edit or delete a webhook.