We're announcing ๐Ÿง‘โ€๐Ÿš€ inter-galactic shipping โœจ for 3025!
Webhook API

โ€‹Webhooks

Endpoint

โ€‹List all webhooks

GET
https://api.sh.example.com/v1
/webhooks

โ€‹List all webhooks โ€บ Responses

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

โ€‹Register a new webhook

POST
https://api.sh.example.com/v1
/webhooks

โ€‹Register a new webhook โ€บ Request Body

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

โ€‹Register a new webhook โ€บ Responses

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