Webhooks
Update a webhook endpoint
PUT
https://backend.immut.io/api/v1/webhooks/{id}Required scope: webhooks:manage
Not usable by an agent key, which never carries webhooks:manage.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | id of the target record |
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
url | string | no | HTTPS endpoint to deliver to (optional) |
events | string | no | array of event names to subscribe to (optional) |
isActive | string | no | true or false (optional) |
Responses
| Status | Meaning |
|---|---|
200 | Success |
400 | BadRequest |
401 | Unauthorized |
403 | Forbidden |
429 | RateLimited |
Example
curl -X PUT "https://backend.immut.io/api/v1/webhooks/<id>" \
-H "Authorization: Bearer $IMMUT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"<url>","events":"<events>","isActive":"<isActive>"}'
Generated from the immut API contract, version 1.9.0. Machine-readable: this page as markdown · everything in one file · OpenAPI