Register a Tracking Webhook

Registers a webhook to send tracking updates at the provided URL for the tracking numbers specified. The webhook data sent will be the same as that pulled from GET Tracking, sent every time the tracking events change. Each tracking number can only be registered to one webhook per account. Sending a new webhook registration for the same tracking number will overwrite the existing webhook registration for that tracking number. If you would like to have a single webhook set up to capture all tracking for an account, please contact Tusk.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
tracking_numbers
array of strings
required

Tracking numbers to register for webhook updates.

tracking_numbers*
string
required

Url to send webhook updates to. Http Requests are sent as a POST to this url.

string

API key to authenticate the webhook request. Sent as a header in the POST request with key "x-api-key". If not provided, no authentication header will be sent.

Responses

401

Unauthorized

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json