Xenioo
  • Welcome!
  • Basic Concepts
    • Your Account
      • The Free plan
      • Upgrading to a paid plan
      • Canceling your subscription
      • Deleting your account
      • Additional Packages
      • Support
      • Payment & Invoicing
      • Messages Count
    • Designing your Chatbot
      • Introduction
      • Behaviors
      • Interactions
      • Actions and Operations
    • Chatbot Details
      • Chatbot Settings
        • General Chatbot Settings
        • Chatbot Conversation Settings
        • Chatbot Integration Settings
      • Teams
        • Team Permissions
        • Team Message Templates
        • Team Member Access
      • Backup & Restore
      • Clone and Reference Clone
    • Publishing
      • Live & Draft Chatbots
      • Publish Your Bot
      • Channels
        • Web
          • Web Variables
          • WordPress
          • Widget Customization
            • Initialization
            • Scripting
        • WhatsApp
          • WhatsApp Variables
          • First Message Processing
          • Configuring Providers
            • Infobip
            • ZOKO
            • MessengerPeople
            • Twilio
            • Chat-API
            • Maytapi
            • Wassenger
            • Waboxapp
        • RCS
          • RCS Variables
          • Configuring Providers
            • LINK Mobility
        • Google Business Messages
          • Google Business Messages Variables
        • SMS
          • SMS Variables
          • Configuring Providers
            • LINK Mobility
        • Facebook
          • Facebook Ads Integration
          • Feed Integration
          • Messenger Referral
          • Facebook Variables
          • Moving users from an existing bot to Xenioo
        • Telegram
          • Telegram Deep Linking
          • Telegram Variables
        • Slack
          • Configuring Slack
          • Slack Variables
        • Microsoft Teams
          • Microsoft Teams Variables
        • Discord
          • Discord Variables
        • Alexa
          • Troubleshooting
          • Alexa Variables
        • Google Assistant
          • Google Assistant Variables
        • Phone
          • Phone Variables
          • Configuring Providers
            • Voximplant
        • Custom
          • REST Reference Guide
          • API Variables
    • Users and Conversation Persistance
  • Artificial Intelligence
    • Intents
    • Expressions
    • Entities
      • Creating Manually
      • Entity Types
      • Synonims
    • Training & Testing your Model
      • Using the NLP Parse Logs
      • Importing Intents From File
    • NLP Master
  • Database
    • Xenioo Database
    • Collections
      • Import And Export Collections Data
    • Database API Interface
      • Url Filtering Syntax
      • Save To Collection
      • Delete From Collection
      • Query Collection
      • CSV Direct Data
  • Broadcasts
    • Broadcasts
      • Settings
        • On Demand
          • HubSpot
        • On Date And Time
        • On Time
        • On Trigger
        • On Interval
    • Campaigns
    • Distribution Lists
    • Audiences
    • Distribution Logs
  • Conversations
    • Conversations
    • Contacts
    • Chat Commands
    • Contact Details
    • Data Retention
  • Actions And Operations
    • Execution
      • Execution Diagram
    • Actions Availability
    • Variables and Tags
    • Dynamic Parsing And Content
    • Content
      • Text Action
      • Random Text Action
      • Quick Reply Action
      • Database Quick Reply Buttons Action
      • Quick Reply Array Action
      • Chat Delay Action
      • Phone Quick Reply Action
      • Email Quick Reply Action
      • Location Quick Reply Action
      • Display Location
      • Image Action
      • Video Action
      • Audio Action
      • File Action
      • Url Action
      • NLP Topics Summary Action
      • Highly Structured Message
      • Custom Class
    • Input
      • Voice Recognition Action
      • Global Detection
        • Text Parse Action
        • NLP Processing Action
        • Dialogflow Detection Action
        • IBM Watson Assistant Intent Detection Action
      • Generic Input Action
      • NLP Input Action
      • Number Input Action
      • Email Input Action
      • Phone Number Action
      • Media Attachment Action
      • Voice Input Action
      • Global Detection Action
      • Dialogflow
        • Dialogflow Input Action
        • Dialogflow Detection Action
      • IBM Watson Assistant
        • IBM Watson Assistant Input Action
        • IBM Watson Assistant Detection Action
    • Flow
      • Go To Action
      • Include Interaction Action
      • Random Split Action
      • Flow Control Action
      • Set Chat Operator State Action
      • Schedule Behaviour Action
      • Variable Switch Action
      • Tag Switch Action
      • Set Context Action
      • Conversation Bookmark Action
      • Create Conversation URL Action
      • Reset Conversation Action
      • Control Conversation Transfer Action
        • Forward Variable Value Action
    • Forms
      • Form Container
      • Fields
        • Text Box
        • Password
        • Text Area
        • Dropdown
        • Checkbox
        • Number
        • Date Picker
        • Time Picker
        • Calendar
        • File Upload
      • Layout
        • Image
        • Literal
        • Divider
        • Html Content
        • Custom CSS
    • Database
      • Load Single Record
      • Delete Records
      • Save Record
      • Save Raw Model
      • Query Collection Data
      • Move To Next Record
      • Set Field Filter Value
      • Order By Field
      • Set Field Value
    • Cards
      • Carousel Template Action
      • List Card Template Action
      • Buttons Card Template Action
      • Card Container Action
      • Interactive Message Action
      • One-Time Notification Request Action
      • Database Carousel Action
      • Dynamic Carousel Action
      • Card And Menu Buttons
        • Postback Button Action
        • URL Button Action
        • Call Phone Button
        • Share Button Action
        • Nested Button Action
        • Interactive Button
    • Profile
      • Set Variable Action
      • Delete Variable Action
      • Set Tag Action
      • Delete Tag Action
      • Set Campaign Subscription Action
    • Privacy
      • Forget User
      • Privacy Opt-In
      • Privacy Flag Condition
    • IoT
      • Control Device State
      • Device State Switch
    • Integration
      • Call API Service Action
      • Execute Cloud Script Action
        • Base Conversation object methods
        • Firebase Connection methods
        • Xenioo Database Collection Methods
      • Execute Client Script Action
      • Send SMS Message
      • Dynamic Content Action
      • Post To Facebook Action
      • Firebase Database Action
      • ActiveCampaign Action
      • Zapier Webhook Action
      • MailChimp Contact Action
      • Wordpress Search Action
      • RSS & Podcast Feed Action
      • SendGrid Mail Action
      • Send Mail Action
      • Send Custom Mail Action
  • Xenioo API
    • Choosing your API
    • Global Platform API
      • Authorization
      • Platform SSO
      • Bots
        • Publish
        • Clone
        • Reference Clone
        • Teams
          • List
          • Add Or Update
          • Delete
      • Conversations
        • Exist
        • Data
        • Share Url
      • AI
      • Statistics
        • Runtime Data
        • Report Files
        • Download Report File
      • Broadcasts
        • Broadcasts List
        • Broadcast State
  • Service State
    • Scheduled Maintenance
    • Platform Changelog
Powered by GitBook
On this page
  • API Token
  • API Secret
  • Events Webhook URL

Was this helpful?

  1. Basic Concepts
  2. Chatbot Details
  3. Chatbot Settings

Chatbot Integration Settings

The integration settings page of your chatbot allows you to change or review many global aspects of your chatbot. Additional integrations are available as actions on your chatbot flow.

PreviousChatbot Conversation SettingsNextTeams

Last updated 3 years ago

Was this helpful?

API Token

This code represent your chatbot API Token. Depending on the different outside integrations you will use you may need it to call specific Xenioo API related to your chatbot.

API Secret

This code is the API Secret used in various real time integrations meant to directly access data of your Account or Chatbot.

Events Webhook URL

In the Events Webhook field you can specify a webhook url that will receive all of the messages that are sent and received by Xenioo for the current chatbot as well as different events you can enable or disable at will.

When the Webhook is activated, Xenioo will automatically send any of the selected events generated by your chatbot every 20 seconds.

The Webhook payload is always an array of items similar to the example below:

[
  {
    "Type": 0,
    "ItemType": "Text",
    "Data": "Hey you, I'm your chatbot!",
    "Date": "2019-07-10T15:47:58.580873+00:00",
    "BotToken": "...",
    "AccountName": "Matelab Srl",
    "ConversationId": "...",
    "UserName":"conversation user name",
    "Channel": "TelegramChannel"
  },
  {
    "Type": 1,
    "Data": "Hello there!",
    "Date": "2019-07-10T15:47:58.5750058+00:00",
    "BotToken": "...",
    "AccountName": "Matelab Srl",
    "ConversationId": "...",
    "UserName":"conversation user name",
    "Channel": "TelegramChannel"
  },
  {
    "Type":3,
    "BotToken": "...",
    "AccountName": "Matelab Srl",
    "Name":"Intent Name",
    "Key":"Intent Key"
  },
  {
    "Type":7,
    "BotToken": "...",
    "AccountName": "Matelab Srl",
    "Text":"Missed AI Text"
  },
]

Each array entry can have the following fields:

Field

Description

Type

The type of entry, according to the table below.

ItemType

ItemSubType

Data

The content of the message. It can be either the text sent by the user or the message sent by the chatbot. If the user clicks a button this field will contain both its text and its payload.

Date

The exact date of the message

BotToken

The unique bot token associated to the chatbot generating the item

AccountName

The full name of the account generating the item

ConversationId

The Id of the conversation associated to this item

Channel

The name of the channel that generated the item

Text

The text that was not detected by Xenioo AI

Name

The name of the Intent or Entity related to the event

Key

The key of the Intent or Entity related to the event

Message type can have one of the following values:

Value

Type

0

Chatbot chat message

1

User chat message

2

A conversation error has occurred

3

An intent was updated

4

An intent was deleted

5

An entity was updated

6

An entity was deleted

7

8

9

A user returned to talk with the chatbot. This event is fired only once every 24 hours even if the user comes back multiple times during the day.

10

Take Over happened

11

Hand Over happened

12

The conversation hit a fallback interaction

13

The conversation hit a wrong question reply

The expected Webhook reply must be a standard HTTP 200 OK. The reply body can be empty. If your Webhook fails to correctly reply or is unreachable for more than 10 times Xenioo will stop any further call and alert your account. To re-enable the Webhook simply save again the chatbot settings. A failing Webhook will also trigger an alert email to the account email directly related to the chatbot. Each message sent to your chatbot by a user or delivered by your chatbot to any user will be queued and delivered to your hook at a latency of maximum 20 seconds.

The specified Webhook is ignored if your bot is running under a free plan.

The Events Webhook is not intended as a real-time communication API relay as the average interval for events signal is 20 seconds. This means that all events happened in a conversation will be grouped and sent to your hook with a 20 seconds delay. If you are looking to build an alternate view based on real-time conversation events please refer to our solution

The item specific .

The subtype of the item specific .

A user chat message was not detected by Xenioo

New user connected to the chatbot. The user has never contacted the chatbot before (or has been ).

This feature is used on your bots as long as you have an . Each call to your hook will . Xenioo will consider one single outgoing message regardless of the amount of in and out messages sent to the hook in each single push. So for example if a hook call contains 30 messages that will still count as only one additional outgoing message.

Custom Channel
active paid subscription
count as an additional outgoing message
visual type
visual type
forgotten
Automatic Intent Redirection