update-webhook
Update a webhook's attributes using JSON Patch, allowing partial modifications without altering unchanged fields.
Instructions
This endpoint updates a Webhook identified by the webhookId parameter with a collection of JSON Patch operations.
The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change.
For example: We have the following resource.
{
"webhookId": 6,
"url": "https://example.com/hook",
"httpMethod": "post",
"content": "null",
"webHookHeaders": []
}If we send an update request body as below (it changes the content field and adds a new HTTP header):
[
{
"op": "replace",
"path": "/content",
"value": "Some webhook content."
},
{
"op": "add",
"path": "/webHookHeaders/-",
"value": {
"key": "X-Custom-Header",
"value": "Custom header value"
}
}
]Only the content and webHookHeaders are updated and all the other attributes remain unchanged.
So we get a response like this:
{
"webhookId": 6,
"url": "https://example.com/hook",
"httpMethod": "post",
"content": "Some webhook content.",
"webHookHeaders": [
{
"key": "X-Custom-Header",
"value": "Custom header value",
"isSecure": false
}
]
}Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| webhookId | Yes | The identifier of the Webhook. | |
| requestBody | Yes |