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

Schemas


Webhook

  • urlstring · uri · required

    The URL where webhook events will be sent

  • eventsstring[] · required
    Enum values:
    shipment.created
    shipment.in_transit
    shipment.delivered
    shipment.exception
  • idstring · uuid · readOnly
  • activeboolean
    Default:
  • createdAtstring · date-time · readOnly
  • secretstring · writeOnly

    Secret used to sign webhook payloads

Error

  • codestring · required
  • messagestring · required