For an introduction to Shipup webhooks, please read the guide here. This documentation is a reference for the different webhook settings and fields.
Here is the list of webhook event types that you can register:
TYPE | DESCRIPTION |
---|---|
| Sent when a new tracker is received by Shipup |
| Sent when a new shipping event is retrieved for a tracker |
| Sent when a notification is generated |
| Sent when a feedback is generated |
Webhook event format
When an event corresponding to your webhook settings' webhook event type occurs, Shipup will send a JSON formatted webhook event to the endpoint specified in your webhook settings using the following format:
FIELD | DESCRIPTION |
---|---|
id | Unique identifier of the webhook event |
object | Object type. Will always be |
data | Data of the webhook event. See format below |
livemode | Has the value |
retry_count | Webhook event POST retry count. This counter starts at 0 and will increase as the webhook fails being sent |
type | Type of webhook. See table above for the different type codes |
created_at | Time at which the webhook was created. Will not be updated afterwards and will be prior to the time the webhook is actually sent |
The data
field object of the webhook event will have the following format:
FIELD | DESCRIPTION |
---|---|
object | Root object of the webhook event. For example if the |
reason | Information about what triggered the webhook event. For example if the |