Chatlayer Documentation
Get in touchMore about Chatlayer.ai
Search…
Welcome to Chatlayer 👋
Getting started
Planning your bot
Creating a new bot
Adding content to your bot
Detecting information in expressions
Asking user info through input validation
Flow navigation with variables
Understanding users
Natural Language Processing (NLP)
Multilingual bots
Context
Bot management
Analytics
Bot dialogs
Conversation history
Events
How to publish your bot
Settings
Organization Management
Access Control
Integrations
API integration
Code Editor
Human handover & live chat
Integrations 101
App Integrations
Message types
Channels
Channels
Facebook Messenger
Google Assistant
Phone & voice
Sinch Conversation API
Web chat widget
Webhook channel
WhatsApp Business API
Workplace from Facebook
Chatlayer API
V1 API Reference
Tips & Best practices
Bot templates
Bot-building best practices
Bot maintenance
NLP best practices
Not understood bot dialog
Solving bot issues
Voice design
Tutorials
Create a web widget demo page
Gathering user feedback
Recognizing a returning user
Reusing flows
Skip introduction message
Using time in your chatbot
Support
Billing & subscription
Frequently Asked Questions (FAQ)
Get in touch
Platform Glossary
SaaS Regions & IP Ranges
Status
✨
What's new
Powered By GitBook
Webhook channel
The Webhook channel provides a way to build a custom integration with Chatlayer that acts as a channel.
With the Webhook channel you can enrich the information sent via certain Channels. For example, instead of using the 'regular' Facebook Messenger or Whatsapp channel, you can use Webhook as a channel and send your messages via Webhook to Messenger or Whatsapp.
With a regular channel integration, the channel is directly connected to Chatlayer
​
By using the Webhook channel, the channel of choice is indirectly connected with Chatlayer
The two images above show the difference between using the channel of your choice directly, or if you would like to use Webhook to enhance the channel possibilities.
Don't confuse the Webhook channel, a custom integration channel, with Webhook offloading, designed for offloading to human agents.

Sending User Messages & Receiving Bot messages

Our platform provides the following features:
  • a Webhook message API endpoint to send a user message to the bot
  • a Webhook configuration to be notified when bot messages are returned as response to a user messages sent to the webhook message API as described in this section. This API is almost realtime and the purpose is to be able to trigger event-based behavior as soon as a bot message response occurs . This way you will be able to integrate the bot flow logic in your own application or message channel.
The overall mechanism is loosely based on Pubsub protocol and relies on HTTP request containing the bot message response being sent to a consumer Endpoint URL. The customer webhook Endpoint URL can be configured on our platform as described in this section.

Registering a webhook API

You can register a webhook API by adding a new channel type webhook in your channel configuration:
Now configure both settings:
  • Webhook URL: this URL must either be publicly available, or at least available from our platform's IP range. We strongly advise using HTTPS for this endpoint.
  • Verify token: This can be any arbitrary string, but it is recommended to be chosen at random.
post
customer webhook endpoint URL configured in Chatlayer.ai
Webhook messages

Message objects

A bot message sent to the customer webhook endpoint URL and returned as response to a user messages can have different object structures, depending on the message type. Want to learn how to build these message objects? Read about it here:
Previous
Live example web widget
Next - Channels
WhatsApp Business API
Last modified 8mo ago
Copy link
Contents
Sending User Messages & Receiving Bot messages
Registering a webhook API
post
Webhook messages
Message objects