Skip to main content

Update Webhook

PATCH 
/v1/webhooks/:webhookId

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
    }
  ]
}

Request​

Path Parameters

    webhookId int32required

    The identifier of the Webhook.

Body

required

  • Array [

    • op OperationTyperequired

    Possible values: [unknown, add, remove, replace, move, copy, test]

    path stringrequired

    Possible values: non-empty

    The source path.

    from stringnullable

    The target path.

    value nullable

    The discrete value.

  • ]

Responses​

When the update was successful.

Schema

    webhookId int32

    The identifier of the Webhook.

    url stringnullable

    The URL of the Webhook.

    httpMethod WebHookHttpMethod

    Possible values: [get, post]

    content stringnullable

    The HTTP body content.

    webHookHeaders

    object[]

    nullable

    List of HTTP headers that the Webhook must send.

  • Array [

    • key stringrequired

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-zA-Z0-9_\-]*$

    The HTTP header key.

    value stringrequired

    Possible values: non-empty and <= 1000 characters, Value must match regular expression ^[a-zA-Z0-9\- _\\:;.,\/"'?!(){}\[\]@<>=+*#$&|~^%]*$`

    The HTTP header value.

    isSecure boolean

    Indicates whether the header value is sensitive.

  • ]

    • config

    object

    The Config where the applied changes will invoke the Webhook.

    name stringnullable

    The Config's name.

    configId uuid

    The Config's identifier.

    environment

    object

    The Environment where the applied changes will invoke the Webhook.

    name stringnullable

    The Environment's name.

    environmentId uuid

    The Environment's identifier.

Loading...