Register a webhook endpoint

Creates a new webhook subscription. Returns the full webhook object including the signing secret (shown only on creation).

Authentication

AuthorizationBearer

Autolane Platform API key. Org-scoped with granular permissions. Deliveries endpoints additionally require an x-retailer-id header containing the site UUID from the Autolane Portal; webhooks endpoints do not.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
HTTPS URL where webhook events will be delivered.
eventslist of enumsRequired
Events to subscribe to.
Allowed values:

Response

Webhook created. The signing secret is returned in full.
successboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error