We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!

Webhook API

Schemas

Webhook

url

string · uri · required

The URL where webhook events will be sent

events

string[] · required

Enum values:

shipment.created

shipment.in_transit

shipment.delivered

shipment.exception

id

string · uuid · readOnly

active

boolean

Default: true

createdAt

string · date-time · readOnly

secret

string · writeOnly

Secret used to sign webhook payloads

Error

code

string · required

message

string · required

Webhook API

Schemas

Webhook

url

string · uri · required

The URL where webhook events will be sent

events

string[] · required

Enum values:

shipment.created

shipment.in_transit

shipment.delivered

shipment.exception

id

string · uuid · readOnly

active

boolean

Default: true

createdAt

string · date-time · readOnly

secret

string · writeOnly

Secret used to sign webhook payloads

Error

code

string · required

message

string · required