Webhooks

Update Webhook

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
    }
  ]
}
patch/v1/webhooks/{webhookId}

Request

Path parameters

webhookIdinteger required

The identifier of the Webhook.

Request body

op'unknown' | 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required
pathstring required

The source path.

fromstring nullable

The target path.

valueunknown

Response

When the update was successful.

webhookIdinteger required

The identifier of the Webhook.

urlstring required

The URL of the Webhook.

httpMethod'get' | 'post' required
contentstring nullable required

The HTTP body content.

Changes

No recorded changes to this operation across all 6 revisions of this API.