Actions

This node is used to run actions. Some of the actions can also be added directly into certain nodes without creating separate Action node. For example In a quick reply, you might want to save the option selected by user to the profile field. This can be done via adding action on response to the quick reply node.
Below is the JSON representation of the action Node, which can be used in Dynamic Node, JSON API Node etc.
{
  "node_type": "ACTIONS",
  "actions_on_enter": [
    //array of actions. Below is the JSON of each action
  ]
}
Below are the list of actions. Certain actions which depends on response(such as saving user input to a profile field) is not available on this node.
Add Tags
It is used to add tags to the user. Tags are displayed beside the chat panel in user's profile, sent in a daily report, can be exported to excel sheet.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "ADD_TAG",
    "tags": [
      "<tag 1>",
      "<tag 2>"//multiple tags can be added
    ]
}
Send Alert
It is used to send notification to human agents. All agents who have subscribed to push notifications, will be sent notification on Mobile App and Desktop browser.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "NEEDS_ATTENTION"
}
Set Profile attribute
It used to set profile attribute to certain value. Profile attributes are displayed beside the chat panel in user's profile, sent in a daily report, can be exported to excel sheet.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "SET_ATTR",
    "attr": "key",
    "value": "value"//only string values are valid
}
Save As Profile Attribute
This is used to save user's response to a profile attribute. For example if a quick reply has 3 options A,B,C and user selects B then B will be saved to specified profile field. This action can be added on those nodes only which accepts response, such as Quick Reply, Quick Reply(with branches), Questions of Form Node, Ask Question, Date Picker, Slider etc.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "SAVE_TO_ATTR",
    "attr": "key"//field to save the response
}
Remove Profile Attribute
This is used to remove a profile attribute dynamically. 
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "REMOVE_ATTR",
    "attr": "key" //attribute field name
}
Send Lead Email
It is used to trigger New lead email. You can set maximum delay of 900 seconds to send New lead email. If you choose the default recipients, those who have turned on New Lead notifications, will get the emails. Additionally you can also specify recipients  to send the email, which will override personal preferences to receive emails.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
//to send emails to default recipients
{
    "type": "SCHEDULE_LEAD_EMAIL",
    "timeout_secs": 1,//between 0-900 seconds
    "emails": null,
    "recipient_type": "DEFAULT"
}
​
//to send emails to specified recipients
{
    "type": "SCHEDULE_LEAD_EMAIL",
    "timeout_secs": 1,//between 0-900 seconds
    "emails": "<comma separated list of emails>",
    "recipient_type": "SPECIFIC_EMAILS"
}
Change Input box State
It is used to enable or disable Input box for users. If Input box is disabled, a user in your website will not have the Input box to type any response, instead s/he has to select from the given options in the chat flow. Please note that Input box will remain hidden until you have added another action later in the flow to show Input box again.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "CHANGE_INPUT_BOX_STATE",
    "state": "HIDDEN"// can be HIDDEN or ENABLED
}
Close Chat widget
It is used to close the chat widget. You can use this action at the end of chat when user has finished the chat, and you would like him/her to view  your website.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "CLOSE_CHAT_WIDGET"
}
Set Temporary variable
It is used to set a temporary profile field to the user. It is not shown in user profile, reports and it gets deleted on next session. It can be used in Dynamic Node, JSON API  Node or conditional branching Node.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "ADD_CONTEXT_VAR",
    "key": "key",
    "value": "val" //Any value such as string, numbers, object, arrays are valid
}
Save As Temporary Variable
This is used to save user's response to a temporary attribute. For example if a quick reply has 3 options A,B,C and user selects B then B will be saved to specified profile field. This action can be added on those nodes only which accepts response, such as Quick Reply, Quick Reply(with branches), Questions of Form Node, Ask Question, Date Picker, Slider etc.
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "SAVE_TO_CONTEXT",
    "key": "key"//field to save the response
}
Remove Temporary Variable
It is used to remove temporary variable
Below is the JSON representation of this, which can be used in dynamic node or JSON API node.
{
    "type": "REMOVE_CONTEXT_VAR",
    "key": "key"
}
​

Client Javascript

Next - AI Builder

Actions

Last modified 1yr ago

Copy link

Outline