Getting started

📘

Before you start

You will need a channel account in order to create a Webhook. If you don't have one, please visit Channel and create a new account now :)

Create a webhook

Before using this feature, first you need to create a model. A channel can have multiple webhook models. You can find its configuration under "Settings > Webhook".

Once you are on Webhook, click on Create new webhook and fill out boxes below.

  • Set a name (e.g. Welcome Webhook)
  • The URL path for your webhook
  • Keywords for filtering. If you set keywords, you can get messages which contain one of the provided keywords. For example, if the keywords are "-foo" and "-test", messages including "-foo bar" will be sent via Webhook because it contains "-foo". If you leave it empty, we will not filter any keywords and send them all. The user chat open message is not filtered by keywords.
  • Options for alarming. Now we provide two options: User chat and event notification and Group chat notification. When User chat and event notification is on, we send Webhooks when someone typed messages in the user chat. When group chat notification is on, we send Webhooks when someone typed in group chat. But we do not send Webhooks for private group chat or direct messages.

Once you set all configurations, click Confirm. And that's it! You just created the first webhook for your service. :100:

📘

After the webhook is successfully created, we will notify events to URL you set in the webhook through POST call.

POST https://YOUR_SERVER_ENDPOINT/PATH?token=TOKEN_VALUE

Response

If your HTTP status code of response for our webhook request is 4XX or 5XX (ex. 404 not found), we accept the request as failed. If it fails 100 times in a row, the webhook will be blocked.

You can check the status of your webhook and you can easily unblock it with one click.