Custom
Last updated
Last updated
The Xenioo Custom Channel allows any application capable of making simple RESTful https calls to integrate and interact with a Xenioo chatbot. This channel is available for live publishing only after adding the Custom Channel Package to your premium account.
Using the Xenioo Custom Channel you will be controlling the way the conversation will be displayed to the user as well as being able to change runtime variables anytime.
The custom channel allows the creation of both completely custom chat channels (e.g.. a mobile app, a custom voice provider) and the integration of external services into existing services and conversations.
Custom Channel is not enabled by default. You can enable custom channel by activating the associated additional package.
This the integration endpoint that you must use to call all API methods allowed by this channel.
This is the URL that Xenioo will automatically call for every message that is generated "offline" from your connection. Messages such as Broadcasts and pushed content that may be sent to your chatbot while the user is not connected will be redirected to this hook. If you enable the "Include All Channels Conversations" flag, the specified URL will receive all messages and replies exchanged on all your bot active channels.
Messages sent to the Webhook URL have a very low latency, meaning that they are forwarded to your Webhook URL nearly as soon as they are processed. If you are building campaigns, broadcasts or just approach a big audience, make sure that your endpoint is capable of sustaining a continuous high number of requests.
If your Webhook URL fails to reply for more than 5 consecutive times, it will be banned from any update for the next 5 minutes. After 5 minutes delivery will resume from the latest update after the ban period.
When this flag is enabled your Webhook endpoint will be receiving real-time user and chatbot events from any conversation happening on any chatbot channels.
Each notification message sent in real-time from another conversation channel will be counted as an additional action message.
By default, the Custom Channel integration API will require a bot level authorization token to be created and supplied on each REST call. By enabling this flag, the Custom Channel will require simply the bot API Key to be supplied in the authorization header.