Category
Webhook
Webhook
Get a single Webhook
Retrieve a single Webhook. Parameter Accessible via URL https://api.channel.io/open/v5/webhooks/{id} and HTTP GET This method accepts application/json Parameter Example Required Description Parameter type id 1004 Required ID of Webhook Path Example GET https://api.channel.io/open/v5/webhooks/1004 Response Returns a Webhook object { "webhook": { "id": "string", "channelId": "string", "name": "string", "url": "string", "token": "string", "createdAt": 1656032153401, "scopes": [ "userChatOpened" ],
List of Webhooks
Retrieve a list of Webhook objects. Parameter Accessible via URL https://api.channel.io/open/v5/webhooks and HTTP GET This method accepts application/json Parameter Example Required Description Parameter type since 123124122 Optional Epoch time in microseconds of the first message to be retrieved Query limit 25 Optional Restrict the maximum number of webhooks to be retrieved Query Example GET https://api.channel.io/open/v5/webhooks Response Returns a list of Webhook objects. { "next": 1656032153
Create a Webhook
Create a Webhook object. Parameter Accessible via URL https://api.channel.io/open/v5/webhooks and HTTP POST Present parameters in POST body. This method accepts application/json Parameter Example Required Description Parameter type name channelWH Required name of Webhook Body url http://www.channel.io/ Required a URL for Webhook Body Example POST https://api.channel.io/open/v5/webhooks Your POST request body should look like { "name": "string", "url": "string", "scopes": [ "userChatOpened" ], "a
Update a Webhook
Update the fields of a Webhook object. Parameter Accessible via URL https://api.channel.io/open/v5/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/v5/webhooks/12345 Your PATCH body should look like { "name":"string", "url":"string", "scopes":[ "userChatOpened" ], "apiVersion":"string", "bl
Delete a Webhook
Delete a Webhook object. Parameter Acccessible via URL https://api.channel.io/open/v5/webhooks/{id} and HTTP DELETE Parameter Example Required Description Parameter type id 12345 Required ID of Webhook 12345 Example DELETE https://api.channel.io/open/v5/webhooks/12345 Response Returns a HTTP status code of 204 if succeeded