System attributes

This is a complete list of system attributes for your reference. For your convenience, we’ve grouped them by contexts where each attribute can be used.

Table of content

General attributes

$_last_errorlast runtime error description
$_agentidID of the chatbot
$_skillcurrent skill name
$_useridunique user identifier, not related to messenger-specific ID
$_randomrandom value from 0 to 1
$_now_tscurrent UNIX timestamp
$_yearcurrent year
$_monthcurrent month (1-12)
$_datecurrent date (1-31)
$_daycurrent day of the week (1-7)
$_hourcurrent UTC time (hours) (0-23)
$_minutecurrent UTC time (minutes) (0-59)
$_secondcurrent UTC time (seconds) (0-59)
$_event_ <name>_payload“ref” parameter or payload for specific event
$_last_user_inputlast message received from the user
$_last_user_input_tstimestamp of last user message
$_last_btn_pressedlast button pressed by the user
$_last_btn_pressed_tsthe timestamp of last button press
$_srcUser’s communication channel: facebook / telegram / twilio / cis (for chat widget)

Facebook Messenger user attributes

$_idpage-specific user ID
$_nameuser’s full name (from Facebook profile)
$_first_nameuser’s first name (from Facebook profile)
$_last_nameuser’s last name (from Facebook profile)
$_localeuser’s locale
$_timezoneuser’s timezone

Telegram user attributes

$_idpage-specific user ID
$_telegram_usernameuser’s @username (from Telegram profile)
$_telegram_first_nameuser’s first name (from Telegram profile)
$_telegram_last_nameuser’s last name (from Telegram profile)
$_telegram_language_codeuser’s language code (from Telegram profile)
$_telegram_is_botthe user is a bot?
$_first_namesame as $_telegram_first_name
$_last_namesame as $_telegram_last_name

Twilio user attributes

$_idTwilio user ID
$_twilio_user_phonenouser’s phone number (from Twilio)
$_twilio_bot_phonenobot’s phone number (from Twilio)
$_twilio_serviceSidService ID (from Twilio)
$_tagsuser’s tags
$_sms_result result of the SMS block execution

E-commerce dynamic galleries

$_selected_category_id ID of the product category that was selected in the dynamic gallery
$_selected_category_slug slug of the product category that was selected in the dynamic gallery
$_selected_category_title title of the product category that was selected in the dynamic gallery
$_selected_product_id ID of the product that was selected in the dynamic gallery
$_selected_product_slug slug of the product that was selected in the dynamic gallery
$_selected_product_title title of the product that was selected in the dynamic gallery
$_selected_product_description description of the product that was selected in the dynamic gallery
$_selected_product_price price of the product that was selected in the dynamic gallery
$_selected_product_url URL of the product that was selected in the dynamic gallery
$_selected_product_image image URL of the product that was selected in the dynamic gallery
$_selected_product_inv_qty inventory of the product that was selected in the dynamic gallery
$_selected_product_upsells upsells of the product that was selected in the dynamic gallery
$_selected_product_similars similar products of the product that was selected in the dynamic gallery
$_selected_product_xsells cross-sells of the product that was selected in the dynamic gallery
$_selected_product_var_types variation types URL of the product that was selected in the dynamic gallery
$_selected_product_var_ids list of variation IDs for selected product. Contains single variation ID if there are no product variations. Use it to add single-variation products to shopping cart in Shopify integrations
$_selected_var_id ID of the variation that was selected in the dynamic gallery
$_selected_var_product_id product ID for the variation that was selected in the dynamic gallery
$_selected_var_title title of the variation that was selected in the dynamic gallery
$_selected_var_description description of the variation that was selected in the dynamic gallery
$_selected_var_price price of the variation that was selected in the dynamic gallery
$_selected_var_url URL of the variation that was selected in the dynamic gallery
$_selected_var_image image URL of the variation that was selected in the dynamic gallery
$_selected_var_inv_qty inventory of the variation that was selected in the dynamic gallery

Shopping cart galleries

$_cart_total_qty total amount of items in the chatbot shopping cart
$_cart_total_sum total value of the chatbot shopping cart
$_selected_item_id ID of the selected item in the chatbot shopping cart
$_selected_item_slug slug of the selected item in the chatbot shopping cart
$_selected_item_price price of the selected item in the chatbot shopping cart
$_selected_item_title title of the selected item in the chatbot shopping cart
$_selected_item_image_url image URL of the selected item in the chatbot shopping cart
$_selected_item_url URL of the selected item in the chatbot shopping cart
$_selected_item_description description of the selected item in the chatbot shopping cart
$_selected_item_quantity quantity of the selected item in the chatbot shopping cart
$_order_id ID of the order created from the chatbot shopping cart
$_order_id ID of the order created from the chatbot shopping cart
$_order_total total cost of the order created from the chatbot shopping cart
$_order_tax_total tax total of the order created from the chatbot shopping cart
$_order_shipping_total shipping total of the order created from the chatbot shopping cart

WooCommerce orders and customers

$_woo_error WooCommerce-specific error description
$_woo_customer_id customer’s ID
$_woo_customer_email customer’s email
$_woo_customer_first_name customer’s first name
$_woo_customer_last_name customer’s last name
$_woo_customer_role customer’s WordPress role
$_woo_customer_username customer’s WordPress username
$_woo_customer_avatar_url customer’s avatar URL
$_woo_customer_billing_first_name
$_woo_customer_billing_last_name
$_woo_customer_billing_company
$_woo_customer_billing_address_1
$_woo_customer_billing_address_2
$_woo_customer_billing_city
$_woo_customer_billing_state
$_woo_customer_billing_postcode
$_woo_customer_billing_country
$_woo_customer_billing_email
$_woo_customer_billing_phone
customer’s billing details
$_woo_customer_shipping_first_name
$_woo_customer_shipping_last_name
$_woo_customer_shipping_company
$_woo_customer_shipping_address_1
$_woo_customer_shipping_address_2
$_woo_customer_shipping_city
$_woo_customer_shipping_state
$_woo_customer_shipping_postcode
$_woo_customer_shipping_country
customer’s shipping details
$_woo_order_id ID of the created order
$_woo_order_number number of the created order
$_woo_order_status status of the created order
$_woo_order_currency currency of the created order
$_woo_order_total total cost of the created order
$_woo_order_total_tax total tax cost of the created order
$_woo_order_note notes for the created order
$_woo_order_payment_method payment method (slug) of the created order
$_woo_order_payment_method_title payment method (title) of the created order
$_woo_order_billing_first_name
$_woo_order_billing_last_name
$_woo_order_billing_company
$_woo_order_billing_address_1
$_woo_order_billing_address_2
$_woo_order_billing_city
$_woo_order_billing_state
$_woo_order_billing_postcode
$_woo_order_billing_country
$_woo_order_billing_email
$_woo_order_billing_phone
order billing details
$_woo_order_shipping_first_name
$_woo_order_shipping_last_name
$_woo_order_shipping_company
$_woo_order_shipping_address_1
$_woo_order_shipping_address_2
$_woo_order_shipping_city
$_woo_order_shipping_state
$_woo_order_shipping_postcode
$_woo_order_shipping_country
order shipping details

Shopify orders and customers

$_shopify_error Shopify-specific error message
$_shopify_total_results total number of results in Shopify search
$_shopify_total_pages total number of pages (10 results each) in Shopify search
$_shopify_var_total_results total number of results in Shopify variations search
$_shopify_var_total_pages total number of pages in Shopify variations search
$_shopify_cart_id
$_shopify_cart_properties
$_shopify_cart_quantity
$_shopify_cart_variant_id
$_shopify_cart_key
$_shopify_cart_title
$_shopify_cart_price
$_shopify_cart_original_price
$_shopify_cart_discounted_price
$_shopify_cart_line_price
$_shopify_cart_original_line_price
$_shopify_cart_total_discount
$_shopify_cart_discounts
$_shopify_cart_sku
$_shopify_cart_grams
$_shopify_cart_vendor
$_shopify_cart_taxable
$_shopify_cart_product_id
$_shopify_cart_gift_card
$_shopify_cart_final_price
$_shopify_cart_final_line_price
$_shopify_cart_url
$_shopify_cart_image
$_shopify_cart_handle
$_shopify_cart_requires_shipping
$_shopify_cart_product_type
$_shopify_cart_product_title
$_shopify_cart_product_description
$_shopify_cart_variant_title null
$_shopify_cart_variant_options
$_shopify_cart_line_level_discount_allocations

NLP

$_nlp_contexts list of outbound contexts from NLP intent
$_nlp_entity_<entity name> entity value from NLP intent
$_nlp_speech default intent reply from NLP engine
$_nlp_action_complete“true” if slot filling is complete, “false” otherwise

Data validation

$_validation_result “true” if data has correct format, “false” otherwise
$_validation_error text description of the validation error

Google Sheets integration

$_gs_result “Ok” if data was found, text description of error otherwise
$_gs_row row number where data was found
$_gs_a .. $_gs_zz cell values from the row that was found
$_gs_total_pages total number of pages (10 rows each) in the dynamic gallery
$_gs_total_results total number of results (cards) in the dynamic gallery
$_selected_gallery_title title of the card that was chosen by the user in the dynamic gallery
$_selected_gallery_subtitle subtitle of the card that was chosen by the user in the dynamic gallery
$_selected_gallery_image image URL of the card that was chosen by the user in the dynamic gallery
$_selected_gallery_<attribute name> attribute values for the card that was chosen by the user in the dynamic gallery

Google Calendar integration

$_gc_result “Ok” if data was found, text description of error otherwise
$_gc_event_id ID of the event found in Google Calendar
$_gc_event_summary summary of the event found in Google Calendar
$_gc_event_description description of the event found in Google Calendar
$_gc_event_status status of the event found in Google Calendar
$_gc_event_creator creator of the event found in Google Calendar
$_gc_event_start_time start time of the event found in Google Calendar
$_gc_event_start_date start date of the event found in Google Calendar
$_gc_event_end_time end time of the event found in Google Calendar
$_gc_event_end_date end date of the event found in Google Calendar

Page visits tracking

$_last_page_visit_title title of the website page that was last visited by the chatbot user
$_last_page_visit_url URL of the website page that was last visited by the chatbot user
$_last_page_visit_browser browser identifier of customer’s web client
$_last_page_visit_browsername browser name of customer’s web client
$_last_page_visit_browserplatform browser platform of customer’s web client
$_timezone timezone of customer’s web client
$_locale locale of customer’s web client
Was this article helpful to you? Yes 5 No 2

How can we help?