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. 7 operations.

List webhooks

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

Returns the registered webhook endpoints for a tenant.

Auth: Bearer API key

Parameters

Responses

operationId: listWebhooks

Register a webhook

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

Registers a webhook endpoint for a set of event types.

Auth: Bearer API key

Parameters

Request body

application/json (required) — schema WebhookRequest.

Responses

operationId: registerWebhook

Unregister a webhook

DELETE /api/v1/tenants/{tenant_id}/webhooks/{id}

Deletes a registered webhook; event delivery to its endpoint stops.

Auth: Bearer API key

Parameters

Responses

operationId: unregisterWebhook

Get a webhook

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

Returns one registered webhook by id.

Auth: Bearer API key

Parameters

Responses

operationId: getWebhook

Update a webhook

PUT /api/v1/tenants/{tenant_id}/webhooks/{id}

Replaces the endpoint URL, event types, secret, and active flag of a registered webhook.

Auth: Bearer API key

Parameters

Request body

application/json (required) — schema WebhookRequest.

Responses

operationId: updateWebhook

List a webhook's deliveries

GET /api/v1/tenants/{tenant_id}/webhooks/{id}/deliveries

Returns recent delivery attempts for a webhook with their outcomes, so a missed event can be traced to a failed delivery.

Auth: Bearer API key

Parameters

Responses

operationId: listWebhookDeliveries

Test a webhook

POST /api/v1/tenants/{tenant_id}/webhooks/{id}/test

Sends a test event to the webhook's endpoint and reports the delivery result without waiting for a real event.

Auth: Bearer API key

Parameters

Responses

operationId: testWebhook