Skip to main content
POST
Test merchant webhook endpoint

Authorizations

Authorization
string
header
required

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

Headers

Accept-Language
string

Preferred response language when a localized representation is available.

Maximum string length: 64
Example:

"en"

Path Parameters

endpointId
string<uuid>
required

Body

application/json
eventType
enum<string>
required
Available options:
shipment.created,
shipment.confirmed,
shipment.assigned,
driver.accepted,
driver.rejected,
driver.arrived_at_pickup,
shipment.picked_up,
driver.arrived_at_dropoff,
shipment.delivered,
shipment.delivery_failed,
shipment.cancelled

Response

Receiver response status

responseStatus
integer
required
Required range: 100 <= x <= 599
eventType
enum<string>
required
Available options:
shipment.created,
shipment.confirmed,
shipment.assigned,
driver.accepted,
driver.rejected,
driver.arrived_at_pickup,
shipment.picked_up,
driver.arrived_at_dropoff,
shipment.delivered,
shipment.delivery_failed,
shipment.cancelled