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:

TYPEDESCRIPTION
tracker.newSent when a new tracker is received by Shipup
tracker.events.newSent when a new shipping event is retrieved for a tracker
notification.newSent when a notification is generated
feedback.newSent 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:

FIELDDESCRIPTION
id
integer
Unique identifier of the webhook event
object
string
Object type. Will always be webhook_event for this object
data
object
Data of the webhook event. See format below
livemode
boolean
Has the value true for production data and the value false for test data.
retry_count
integer
Webhook event POST retry count. This counter starts at 0 and will increase as the webhook fails being sent
type
string
Type of webhook. See table above for the different type codes
created_at
datetime
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:

FIELDDESCRIPTION
object
object
Root object of the webhook event. For example if the webhook_event_type_code field of the webhook event is tracker.events.new, the root object will be a tracker
reason
object
Information about what triggered the webhook event. For example if the webhook_event_type_code field of the webhook event is tracker.events.new, the reason will contain the ID of the tracker's new event