Create a webhook subscription
GENERATED — DO NOT EDIT DIRECTLY. Produced from the canonical OpenAPI specification by
developer-docs/tools/generate-reference.mjs. Edits are overwritten on the next run.
POST
/management/webhooksScope: webhooks.manage. The URL must be https and must resolve to a public address — loopback, link-local, private ranges and cloud metadata endpoints are refused. The signing secret is returned once, in this response, and cannot be retrieved afterwards; store it before you discard the response. Authenticate with Authorization: ApiKey {key}. Every response carries x-ms-request-id, X-Correlation-Id and X-Request-Id; quote the request id in any support request. Returns 201 on success.
| Operation ID | Webhooks_Create |
| Plane | Management |
| Versioning | ?api-version=2026-08-30 |
| Authentication | Authorization: ApiKey {key} |
| Required scope | webhooks.manage |
| Concurrency | Not applicable |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
api-version |
string |
Yes | Management API version. Supported: 2026-08-30. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-ms-client-request-id |
string |
No | Optional caller-supplied correlation value, echoed back on the response and recorded in diagnostics. It never influences authentication, tenant or environment selection, resource lookup or idempotency. |
Request body
Type: CreateWebhookSubscriptionRequest
| Field | Type | Required | Description |
|---|---|---|---|
events |
array, nullable |
No | |
url |
string, nullable |
No |
Responses
| Status | Body | Meaning |
|---|---|---|
201 |
ManagementResourceOfWebhookSubscriptionResponse |
Created. |
400 |
ErrorEnvelope |
The request was not valid. See error model. |
401 |
ErrorEnvelope |
Authentication failed — the API key is missing, malformed, revoked or expired. |
403 |
ErrorEnvelope |
Authenticated, but the key does not carry the required scope. |
409 |
ErrorEnvelope |
The request conflicts with the resource state, or an idempotency key was reused with a different payload. |
429 |
ErrorEnvelope |
Throttled. See rate limits. |
Response headers: x-ms-request-id
Example
curl -X POST "https://api.example.diligence.id/management/webhooks?api-version=2026-08-30" \
-H "Authorization: ApiKey YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ }'