When the customer is logged in from portal or website, you might want to fetch some customer information like their order ID, date of birth, customer ID, etc, and display it in the bot conversation. The parameters for such information may not be readily available as a placeholder. 'Custom Parameters' in the bot builder helps to fetch just this information.

Deploying your bot:

The 'Generate script' button on this page will generate the widget script for that particular bot. You can copy and paste this script on all your support mediums (portals, webpages, etc.) to deploy your bot. Any changes you make to the bot configuration will automatically reflect in the bot widget, so you will need to paste this script only once on the required support mediums.

A quick guide to setting up Custom Parameters:

  • Login to your chatbot builder account as an Admin/Owner
  • Select the bot you want to edit from the bot list page
  • Click on the ‘Custom parameters’ icon from the right navigation bar
  • The '+ New parameter' button will let you set up a new custom parameter
  • Give your parameter a name
  • Select the 'Source' from the drop-down:
    • JS: If the source is selected as 'JS', you can choose to save the information as part of either the ticket details or the customer details. When JS is chosen, the script that is generated upon clicking the 'Generate Script' button will contain this parameter as a variable. This variable will be a key with its value either hardcoded or fetched dynamically and assigned from the website the script is to be pasted on.

Note: If the custom param of Source JS is marked as mandatory, make sure that the value is available and is fetched from the website for the defined variable - the bot will not load otherwise.

  • API: If the source is selected as 'API', you will be able to select the required response headers of an API from the API library of that bot to initialize the custom parameter. Once this API is called in a flow the custom parameter assumes the value of the response headers mapped to it.

A quick guide to using Custom Parameters:

  • In the chatbot flow, go to/add new dialog and use the content picker under the 'Message or Question' tab and choose 'Custom Param' from the list.

  • Click on the configured custom parameter to add it to the message (custom parameters with source as 'API' will only be displayed here).

Note: Make sure that the API related to the custom param is being called under the 'Actions' tab before using it in a dialog - the values will be fetched only if the API is configured as part of 'Trigger API' under 'Actions'.