We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!
Cosmo Cargo Inc.
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