Skip to main content
GET
Read the merchant's webhook configuration

Authorizations

Authorization
string
header
required

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

Response

The merchant's single webhook; secret material is absent.

endpointId
string<uuid>
required
url
string<uri>
required
status
enum<string>
required
Available options:
ACTIVE,
PAUSED
subscribedEventTypes
enum<string>[]
required
Available options:
shipment.created,
shipment.assigned,
shipment.picked_up,
shipment.out_for_delivery,
shipment.delivered,
shipment.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