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