Webhooks
Register a webhook endpoint
POST
https://backend.immut.io/api/v1/webhooksRequired scope: webhooks:manage
Requires scope webhooks:manage. URLs must be HTTPS in production. The response includes the HMAC signing secret once. Events include document.created, upload.completed, upload.failed, certificate.generated, workspace.created.
Request body
Content type: application/json (required)
| Field | Type | Required | Description |
|---|---|---|---|
url | string | yes | |
events | array | yes | |
description | string | no |
Responses
| Status | Meaning |
|---|---|
201 | Webhook created; body includes the signing secret (shown once) |
400 | BadRequest |
Example
curl -X POST "https://backend.immut.io/api/v1/webhooks" \
-H "Authorization: Bearer $IMMUT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"<url>","events":"<events>","description":"<description>"}'
Generated from the immut API contract, version 1.9.0. Machine-readable: this page as markdown · everything in one file · OpenAPI