GuidesReferenceChangelogVideosDiscord
Sign UpLogin

Start Conversation Chat Bot

The Start Conversation Chat Bot Action is used to start Conversation Chat Bots.

📘

Enterprise Feature

Accessing Conversation Actions requires an ENTERPRISE license. If you would like to enable this feature for your Airkit Organization, please contact your Airkit representative or contact [email protected].

Use Cases

Conversation Chat Bots facilitate two-way, text-based Conversations while also providing features that:

  • allow for the creation of embedded digital assistants capable of automatically answering the most common user questions.
  • allow conversation to transition seamlessly to a more knowledgable third-party when needed.

The Start Conversation Chat Bot Action should be used whenever you want to fire one of these Conversation Chat Bots to automate discussions with users.

Properties

Deployment ID

Expects an External Application Deployment.

External Application Deployments are configured under Settings. They reference deployed Airkit applications, typically ones that define Bot type Routing Flows via Answer Groups. The Bot type Routing Flow defined here will be the one that begins when the Start Conversation Chat Bot Action is fired.

Resource ID

Expects a Conversation Hub Channel Resource.

Conversation Hub Channel Resource are configured under Settings > Conversations. These resources must be associated with a Conversation Hub in the Console before they can be configured inside an application.

External ID

Expects type Text.

This optional field is used to assign an external identifier that can be manually referenced downstream.

Customer Destination

Expects type Text or Phone.

The address of the external Chat source. If the Conversation will take place via a Chat Web Control, the Customer Destination will be the corresponding Session ID. If the Conversation will take place via SMS, the Customer Destination will be the corresponding phone number.

Customer Identifier

Expects type Text.

This optional field is used to assign the end user an identifier that can be manually referenced downstream. This will be used as the identifier to search for users via the Find Conversations by Customer Identifier Data Operation.

Example

In this example, a Start Conversation Chat Bot is configured such that users are immediately routed to a Conversation Chat Bot as soon as they begin a Session. Note how the the Start Chat Bot Action is fired on the Session Started Event:

The Deployment ID points to an Answer Group Management App that has been configured in Settings and is thus available under the profile namespace. The Resource ID points to points to a Web Chat Resource that was configured in Settings after being incorporated into a Conversation Hub in the Conversations Tab of the Console. The Customer Destination is defined by session.id, which indicates that the Conversation will take place in a Chat Web Control incorporated into this very app.