Skip to main content
POST
/
webhook
Create Webhook
curl --request POST \
  --url https://chat.zoko.io/v2/webhook \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "url": "https://client.webhooklabs.com",
  "events": [
    "message:user:in",
    "message:delivery:update"
  ],
  "challengeToken": "client0_letmein"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "https://client.webhooklabs.com",
  "challengeToken": "CHALLENGE_TOKEN",
  "events": [
    "message:user:in"
  ]
}

Authorizations

​
apikey
string
header
required

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Body

application/json

Webhook data

Webhook input data

​
url
string<uri>
required
Example:

"https://client.webhooklabs.com"

​
events
enum<string>[]
required
Minimum length: 1
Example:
[
  "message:user:in",
  "message:delivery:update"
]
​
challengeToken
string

Challenge Token for the webhook

Maximum length: 200
Example:

"client0_letmein"

Response

Created webhook details

Webhook response data

​
id
string<uuid>
​
url
string<uri>
Example:

"https://client.webhooklabs.com"

​
challengeToken
string
Example:

"CHALLENGE_TOKEN"

​
events
enum<string>[]