Register where deliveries go
Sets the single HTTPS endpoint Maat delivers to, and the events you want. Sending this again replaces both — there is only ever one endpoint per partner and workspace, so that the record of who received which guest’s details has one answer.
An empty events array pauses delivery without discarding the endpoint or its
signing secret.
The challenge round-trip
Nothing real is delivered until your endpoint proves it is yours. During this
call we POST a signed endpoint.challenge delivery to the URL you gave us, and
your handler must answer 2xx with a JSON body echoing the same challenge
string:
{ "challenge": "<the value we sent>" }
Echo it and the endpoint becomes active. Anything else — a non-2xx, an
unreadable body, a different value — leaves it pending_verification, and no
booking notification is ever sent to it. Call this endpoint again to retry.
The challenge is signed exactly like a real delivery, so your verification code is exercised before your first real payload rather than after it.
The challenge is re-armed on EVERY call, including one that does not change the URL. A URL that verified in March is not evidence about the same URL in September.
What we check about your URL
https only, on port 443 or 8443, on a publicly resolvable DNS name. We check the
address the name actually resolves to, at the moment we connect — not just at
registration — and we never follow redirects. If a URL is refused you get one
validation_failed; we do not report which check failed.
If your endpoint’s address later stops resolving publicly, we suspend it and stop delivering rather than retrying into it.
The signing secret
Returned once, in the response to this call, and never again — we do not store it in a form anything can read back. Re-registering (a corrected path, a new event list) deliberately does NOT mint a new one, so your existing verification keeps working.
If you lose it or it leaks, ask us to rotate: we issue the next secret and sign
every delivery with both for an overlap window, so you can deploy on your own
clock. See X-Signature-Previous under booking.confirmed.
Availability
This contract is live in the sandbox. On a production workspace it still
returns 501: outbound delivery of guest data is gated on the data-sharing
agreement, the transfer mechanism and the privacy notice, not on code.
A 503 means webhook signing is not configured on our side. Nothing was
registered; retry.
Authorizations
A short-lived partner token, obtained by exchanging your API key at
POST /token. Send it as Authorization: Bearer <access_token>.
Tokens live for fifteen minutes by default and never for more than an hour. Mint one per batch of work, not one per request.
The token carries the workspace and the environment its key was issued for. You cannot change either by asking: the exchange ignores everything in the request body for exactly that reason.
Never send it as a cookie or in a query string, and never store it — store the API key, mint tokens from it.
Body
HTTPS only, a public DNS name only. Checked against the address it resolves to at the moment we connect, on every delivery.
2048^https://An empty array pauses delivery without discarding the endpoint.
16booking.confirmed, booking.cancelled, user.erased Response
The endpoint is registered. Check status: active means the challenge
was echoed and deliveries will flow; pending_verification means it was
not, and nothing will be sent until you call again and echo it.
signing_secret is present only the FIRST time you register. Its absence
on a later call is not an error — your existing secret still applies.
booking.confirmed, booking.cancelled, user.erased pending_verification, active, suspended Returned once, on the call that issues it, and never again. Store it somewhere you can read it back; we cannot.