ScalixScalix Docs
Sign up

Webhooks API

Webhooks API to register endpoint URLs for tenant event types and list registered webhooks in Scalix Cloud for outbound event delivery.

REST API endpoints for Webhooks. 2 operations.

List webhooks

plaintext
GET /api/v1/tenants/{tenant_id}/webhooks

Returns the registered webhook endpoints for a tenant.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
tenant_idpathstringYesTenant id (UUID)

Responses

StatusDescription
200Webhook list
401Missing or invalid API key
500Internal error

operationId: listWebhooks

Register a webhook

plaintext
POST /api/v1/tenants/{tenant_id}/webhooks

Registers a webhook endpoint for a set of event types.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
tenant_idpathstringYesTenant id (UUID)

Request body

application/json (required) — schema WebhookRequest.

Responses

StatusDescription
201Webhook registered
401Missing or invalid API key
500Internal error

operationId: registerWebhook