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

​Webhooks

Endpoint

​List all webhooks

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

Returns a list of all registered webhooks

​List all webhooks › Responses

    • 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

​Register a new webhook

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

Registers a new webhook endpoint to receive shipment updates.

A secret will be generated and returned in the response. This secret should be used to verify the authenticity of webhook payloads.

​Register a new webhook › Request Body

  • 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

​Register a new webhook › Responses

    • 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