Register a webhook endpoint

Registers an HTTPS endpoint for reservation events. Needs webhooks:manage and reservations:read, since the endpoint receives whole reservations. The URL must resolve to a public address; we check that at registration.

The 201 is the only time the secret is shown in full. Store it: every later read masks it, and only a rotation yields a usable secret again. An organization holds at most 10 endpoints, deactivated ones included, because endpoints cannot be deleted; reuse a slot by repointing one with PUT. Idempotency-Key is ignored here, so a create retried after a lost response can register a duplicate that receives every event too; find it with GET /rs/v1/webhooks and switch it off with PUT.

Authentication

AuthorizationBearer

API key generated in the Autolane Portal. Keys are organization-scoped, carry granular permissions, and are environment-specific: a sandbox key only works against the sandbox host, and a production key only against the production host.

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"<=2048 characters

subscribed_eventslist of enumsRequired

Allowed values:

Response

The registered endpoint, carrying its secret in full for the only time

successboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error