Skip to main content
GET
Get 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

Response

Merchant-owned endpoint; signing secret is absent

endpointId
string<uuid>
required
companyId
string<uuid>
required
url
string<uri>
required
status
enum<string>
required
Available options:
ACTIVE,
PAUSED
subscribedEventTypes
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
version
integer<int64>
required
Required range: x >= 0
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
previousSecretValidUntil
string<date-time> | null