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"
],
"apiVersion": "string",
"blocked": true
}
Response
Returns a newly created Webhook
object.
{
"webhook": {
"id": "string",
"channelId": "string",
"name": "string",
"url": "string",
"token": "string",
"createdAt": 1656032153401,
"scopes": [
"userChatOpened"
],
"apiVersion": "string",
"lastBlockedAt": 1656032153401,
"blocked": true
}
}
Updated 12 months ago