Skip to main content
WEBHOOK

Headers

webhook-id
string<uuid>
required

Stable event identifier, matching body.id.

webhook-timestamp
string
required

Unix seconds for this delivery attempt.

Pattern: ^[0-9]+$
webhook-signature
string
required

Space-delimited Standard Webhooks signatures, each v1,.

Body

application/json

Thin event envelope: stable id, event type, occurred_at, team_uuid and resource identifiers in data. Full payloads are not offered in this version. A future full-payload option must be explicitly selected; existing thin subscriptions retain their documented meaning.

id
string<uuid>
required

Stable event UUID, also sent in webhook-id. Duplicate deliveries keep the same id.

occurred_at
string<date-time>
required

When the business event occurred; distinct from the delivery-attempt timestamp.

team_uuid
string<uuid>
required

Resource UUID.

type
enum<string>
required
Available options:
shipment.booked,
shipment.failed,
shipment.cancelled,
shipment.voided
data
object
required

Response

Event durably accepted. Other 2xx responses also acknowledge delivery.