Skip to main content
POST
Configure the merchant's single shipment webhook

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Headers

Idempotency-Key
string

Optional. Retry safety is handled for you: when this header is absent DropHub derives the key from the reference you already send — the order number on a shipment create, the shipment id on a cancel — scoped to your merchant account. Two calls naming the same order are treated as one submission and the second returns the original result. Send your own key only if you want to control the replay window yourself; an explicit key always wins.

Required string length: 16 - 128
Example:

"merchant-order-20260822-0001"

Body

application/json
url
string<uri>
required
Maximum string length: 2048
events
enum<string>[]

Omit to subscribe to every event.

Maximum array length: 7
Available options:
shipment.created,
shipment.assigned,
shipment.picked_up,
shipment.out_for_delivery,
shipment.delivered,
shipment.failed,
shipment.cancelled

Response

Webhook plus the HMAC signing secret disclosed for creation or rotation.

webhook
object
required