Skip to main content
POST
Register an HTTPS endpoint to receive real-time booking status change notifications. See Booking status change for the callback payload, field definitions, and retry behavior.

Authorizations

Headout-Auth
string
header
required

Body

application/json
url
string<uri>
required

HTTPS URL where webhooks will be delivered (must use HTTPS)

Required string length: 1 - 2048
Pattern: ^https://.*
enabled
boolean
default:true

Whether the webhook is active

Response

Webhook configuration created successfully

timestamp
integer<int64>

Response timestamp in milliseconds

message
string | null

Response message

error
object
data
object | null

Response data payload