Update a Webhook

Update the fields of a Webhook object

Parameter

Accessible via URL https://api.channel.io/open/v3/webhooks/{id} and HTTP PATCH

📘

This method accepts application/json

Parameter

Example

Required

Description

Parameter type

id

12345

Required

ID of Webhook object

Path

(property)

(name)

Optional

Property of Webhook

Body

Example

PATCH https://api.channel.io/open/v3/webhooks/12345

Your PATCH body should look like

{
  "name" : "changed"
}

Response

Returns the changed Webhook object.

{
  "webhook": 
    {
      "id": "String",
      "channelId": "String",
      "name": "String",
      "url": "String",
      "token": "String",
      "keywords": [
        "YOUR_KEYWORD_1",
        "YOUR_KEYWORD_2",
        ...
      ],
      "createdAt": 1523345251984,
      "watchUserChats": Boolean,
      "watchMessages": Boolean,
      "apiVersion": "String"
    }
}