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 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.

Create webhooks

  1. Open the console.
  2. In the upper right corner, click your workspace name → Webhooks.
  3. Click Create webhook.
  4. 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.
  5. Click Save.

Test webhooks

  1. Open the console.
  2. In the upper right corner, click your workspace name → Webhooks.
  3. Click Menu inline-iconTestSend test event.

A message will be sent to the URL endpoint.

Manage webhooks

  1. Open the console.
  2. In the upper right corner, click your workspace name → Webhooks.
  3. Click Menu inline-icon to edit or delete a webhook.

Learn more