Skip to main content

Create a webhook

Webhooks allow you to send notifications of Delivery Gateway events to a third-party service.

Updated today

Delivery Gateway webhooks send a JSON payload, the content of which depends on the triggering event. One webhook is one event: create a webhook for each of the events you need to send notifications about.

Webhook events include customer address creation or shipment creation. For all available webhook events, see Webhook events.

Create a webhook

  1. From Integrations, select Webhooks.

  2. Click New webhook.

  3. From the Webhook dropdown menu, select the event that should trigger the webhook.

    Example webhook config
  4. From Transport, select REST.

  5. Enter the service URL in the URL field.

  6. Click Create.

Webhook events

Event

Event ID

Notification when a configuration changes

CONFIGURATION_UPDATED

Notification when customer creates a new address

ADDRESS_CREATED

Notification when customer updates an existing address

ADDRESS_UPDATED

Notification when customer deletes an existing address

ADDRESS_DELETED

Notification when a shipment is created

SHIPMENT_CREATED

Notification when a shipment is updated

SHIPMENT_UPDATED

Notification when a shipment is deleted

SHIPMENT_DELETED

Did this answer your question?