Referral Parameter

You can launch a specific flow (and step) instead of the default Welcome Flow when loading the Assistant by providing a ref query parameter in its URL.

To force the launch of a specific flow when opening the Assistant URL, use the following special syntax:

# will redirect to the step NAME_OF_STEP in the flow called NAME_OF_FLOW

# or, if no step is provided, the `start` step will be used

Injecting Conversation Metadata

By default, the Assistant channel does not include any specific context about the conversation (see the _metadata object documentation). In some cases, it can be useful to load the Assistant (or Widget) with pre-existing metadata.

Some common scenarios:

  • the bot is loaded in a website where the user is already known: in that case, we may be interested in injecting the user's context (name, email...) inside the conversation.

  • the user is authentified on the parent website: in that case, we may want to inject an authentication token into the user's conversation for subsequent calls.

  • the same bot is used across several websites and we want to know which website the user is currently visiting: in that case we can inject a unique website identifier into the conversation.

The injected data is available in the _metadata global variable, available in every flow. The code of the example above is:

  say "Hi {{_metadata.firstname}}"
  say QuickReply(
    "Your email address is: {{}}. Do you confirm?",
    buttons=[Button("yes"), Button("no")]

To add custom metadata in your Assistant, simply add the encoded (with javascript's encodeURIComponent function) JSON string of the metadata you want to inject to the query parameters of the URL. The URL of the Assistant in the example above would be:


Customizing the UI

You can change the appearance of the Assistant by visiting the Design tab of the configuration panel. This lets you have even more control over the final experience for your end users, and match your own branding even better!

Many elements are configurable:

  • Chatbot avatar, header card color and background image

  • User bubble colors

  • Hiding the CSML branding

  • Disabling the speech input

  • And many others!

Last updated