Skip to main content
POST
Register webhook
Register endpoints for quotes, booking confirmations, status, and document events.

Authorizations

Authorization
string
header
required

Body

application/json
url
string<uri>
required
Example:

"https://api.example.com/webhooks"

events
enum<string>[]
required
Available options:
quote.created,
quote.priced,
booking.confirmed,
shipment.status,
document.uploaded
Example:
secret
string
Example:

"webhook-secret-123"

Response

201 - application/json

Webhook registered

webhookId
string
Example:

"webhook-123"

url
string
Example:

"https://api.example.com/webhooks"

events
string[]
Example:
createdAt
string<date-time>
Example:

"2024-01-01T10:00:00Z"