Last updated: 13 December 2021

Your chatbot platform comes loaded with a series of variables. These variables may help you build chatbots faster, create more advanced experiences, or simply be there to make your life easier.

Below is a list of all the built-in variables and a short description of what they do.

Variable

Description

Date & time variables

current_time

Stores the current time.

current_date

Stores the current date.

current_date_time

Stores the current date and time.

current_day

Stores the current day (e.g. Monday, Tuesday, etc.).

current_day_of_month

Stores the current day of the month.

current_month

Stores the current month.

current_year

Stores the current year.

current_hour

Stores the current hour.

current_minute

Stores the current minute.

current_second

Stores the current second.

Live chat variables

queue_position

Stores the subscriber’s position in the live chat queue.

queue_wait

Stores the subscriber’s expected wait time in the live chat queue.

Bot variables

subscriber_identifier

Stores the subscriber’s ID.

subscriber_session_started_at

Stores the date (format: dd-mm-yyyy hh:mm AM/PM) when the subscriber started their session with the chatbot.

subscriber_last_active_at

Stores the date (format: dd-mm-yyyy hh:mm AM/PM) when the subscriber was last active (last sent a message)

subscriber_current_conversation

Stores which conversation the subscriber is currently going through.

subscriber_current_conversation_step

Stores which step of the conversation the subscriber is currently going through.

subscriber_stuck_count

Stores how many times the subscriber has looped back to the same step of a conversation.

subscriber_channel

Stores which channel the subscriber is using to talk to the bot (e.g. Converse, Embed, Facebook Messenger, etc.)

subscriber_location

Stores the subscriber’s location.

subscriber_language

Stores the subscriber’s preferred language.

subscriber_received_cta_at

Stores the date (format: dd-mm-yyyy hh:mm AM/PM) when the subscriber was shown the call-to-action.

subscriber_closed_cta_at

Stores the date (format: dd-mm-yyyy hh:mm AM/PM) when the subscriber closed the call-to-action.

subscriber_token

Stores an auth token that can be used to allow a subscriber to log into the chatbot (e.g. through webhook).

message

Stores the last message sent by the subscriber, falls back to the label if there isn’t a message to store.

label

Stores the label of the button the subscriber clicked.

postback

Stores the postback of the button the subscriber clicked.

user

Specifically used for the auth composer, stores the subscriber’s user information.

password

Specifically used for the auth composer, stores the subscriber’s password information.

NLP variables

confidence_score

Stores the confidence score of a triggered FAQ.

intent_identifier

Stores the ID of a specific FAQ.

FAQ variables

faq_name

Stores the FAQ’s name.

faq_group

Stores the first tag assigned to an FAQ (needs renaming).

faq_section_name

Stores the knowledge base section’s name associated with the FAQ (if any).

faq_section_content

Stores the knowledge base section’s content associated with the FAQ (if any).

faq_section_cover_image

Stores the knowledge base section’s cover image associated with the FAQ (if any).

faq_section_identifier

Stores the knowledge base section’s ID associated with the FAQ (if any).

Small talk variables

small_talk_name

Stores the small talk’s name.

Condition variables

chatbot_url

Stores the URL on which the chatbot is hosted.

subscriber_ip_address

Stores the subscriber’s IP address.

subscriber_user_agent

Stores the subscriber's browser information (e.g. Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0)

subscriber_browser_name

Stores the subscriber’s browser name (e.g. Chrome, IE, etc.).

subscriber_browser_version

Stores the subscriber’s browser version.

subscriber_operating_system_name

Stores the subscriber’s operating system’s name (e.g. iOS, Windows, etc.).

subscriber_operating_system_version

Stores the subscriber’s operating system’s version.

Management platform variables

app_url

Stores the URL on which the chatbot platform is hosted (e.g. bots.website.com).

api_name

Store the company name of the platform owner.

api_url

Stores the API URL associated with the chatbot platform (e.g.name-api.website.com).

bot_server_url

Stores the socket server URL the chatbot connects to.

locale

Stores the locale code associated with the platform’s hosting (e.g. EN).

timezone

Stores the timezone in which the platform is hosted (UTC by default).

Account variables

client_identifier

Stores the ID of the account.

client_name

Stores the name of the account.

client_email

Stores the email address associated to the account.

client_phone_number

Stores the phone number associated to the account.

client_address

Stores the address associated to the account.

Content import variables

knowledge_base_name

Stores the knowledge base’s name.

knowledge_base_section_name

Stores the knowledge base section’s name.

knowledge_base_section_content

Stores the knowledge base section’s content.

knowledge_base_section_cover_image

Stores the knowledge base section’s cover image.

knowledge_base_section_identifier

Stores the knowledge base section’s identifier.

semantic_search_confidence

Stores the confidence score of a triggered semantic search.

Tracked link variables

last_clicked_link_url

Stores the last tracked link the subscriber has clicked within the chatbot.

last_clicked_link_name

Stores the last tracked link’s name the subscriber has clicked within the chatbot.

last_clicked_link_at

Stores the date (format: dd-mm-yyyy hh:mm AM/PM) the subscriber last clicked a tracked link within the chatbot.

Get variables from the webhook payload

webhook_name

Stores the webhook’s name.

webhook_id

Stores the webhook’s ID.

webhook_key

Stores the webhook’s key.