Register a webhook endpoint

Register an https:// endpoint to receive shipment events for your organisation. Accounts have an active-endpoint limit (three by default); inactive endpoints do not consume a slot. event_types is filtered against the supported list on the way in: an unrecognised name is dropped silently rather than rejected, so send only values from the enum and read the returned event_types back to confirm what was stored. An empty or omitted event_types stores an empty list. Every type in the enum has a live producer.

post/v1/webhooks

Request

  • Base URL: https://api.trackingmcp.com
  • URL: https://api.trackingmcp.com/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Destination endpoint. Must start with https://.

event_typesWebhookEventType[]

Events to receive. Names outside the enum are discarded.

descriptionstring

Free-text label for your own bookkeeping.

Response

Endpoint registered. THE secret IS RETURNED ONCE, HERE, AND NEVER AGAIN — no later endpoint returns it and it cannot be re-read. Store it now: it is the HMAC key you verify each delivery's signature against. Losing it means deleting the endpoint and registering a new one.

oktrue

Changes

No recorded changes to this operation across all 1 revision of this API.