Skip to main content

Webhooks configuration

This feature is available for our Pro and Enterprise customers.

Overview​

ZigZag provides a webhook system for sending order shipping events directly to an endpoint on your server. This can be useful when you want to perform specific actions such as:

  • monitoring
  • analyses on carriers
  • triggering of post-delivery marketing emails

Available webhooks​

There are 4 different types of webhooks.

First type - tracker.new
This type is sent when a new tracker is received by ZigZag.

Second type - tracker.event.new
This type is sent when a new shipping event is retrieved for a tracker.

Important

For tracker.event.new webhooks, if an order is received with a delay, ZigZag will synchronize all past events at the same time:

  • All events are sent by webhook at the same time (one webhook per event).
  • The latest tracker status is sent with each webhook. Each webhook contains all past events in the events field.
  • The order of the webhooks sent is not guaranteed.
  • A reason object is always included in the webhook to indicate what triggered it. In this situation, each webhook will have a different reason value, corresponding to the event that triggered the webhook.

Third type - notifications.new
This type is sent when a new ZigZag notification is sent by ZigZag. This webhook must be configured as a channel on each notification that should trigger the webhook.
In particular, this webhook can be used to send your own emails (for example, follow-ups, satisfaction surveys, or other marketing campaigns) triggered by a ZigZag notification (for example, “Package delivered”).

Fourth type - feedback.new
This type is sent when new customer feedback is generated.

You can use Feedback webhooks to tailor future communications to a customer based on their responses to the questionnaire.
Examples:

  • This webhook can be used in Klaviyo to trigger notifications for satisfied customers only.
  • This webhook can be used to send promotional codes x days after delivery for customers who experienced a delivery delay.

How to set up a webhook​

Webhook payload technical documentation

  1. Navigate to Settings -> API & Webhooks
  2. Click Add endpoint to select the type(s) of data you wish to receive.
  3. Add, edit and test the added URL.
  4. Activate, deactivate, edit or delete the list of configured webhooks (see second carousel image).

Activate webhooks in the Notifications Editor​

  1. Navigate to Portal Settings -> Notifications settings -> Editor.
  2. Click Edit next to Channels for your chosen notification.
Without doing this process, the webhooks you have set up will not be able to send you any data.
Important

This process must be carried out for each notification for which you wish to receive data.

This procedure must be carried out for each language activated in your account.