Show Popup
Reference documentation for using the Web Client Show Popup action
Written By Support Channel
Last updated Over 1 year ago
Overview of the Show Popup action
The Show Popup action allows you to display a popup window to a specific user in a Web Client Interface. This popup contains a single HTML window and is ideal for drawing attention to important information or prompting immediate user interaction.
Understanding the Show Popup action
To successfully use the Show Popup action, the following parameters must be configured. These determine where and to who the popup will be shown:
Parameters
Web Client Instance - Select which Web Client instance should receive the popup.
User Email - Enter the email address of the user who should receive the popup. This must be a valid user within the selected Web Chat instance.
Content - Provide HTML content to be displayed in the popup.
Outputs
None
The popup appears as a window over the chat interface, ensuring the user sees and interacts with the content. HTML content is especially useful as it allows you to implement rich content such as images or hyperlinks.
Note
The workflow will automatically terminate immediately after the Show Popup action is triggered. Any steps placed after the Show Popup will not be executed.
Working with the Show Popup action
The Show Popup action allows you to display a popup window to the user during a chat interaction. This can be useful for presenting large sections of media such as a knowledge article or a confirmation.
Create and manage Show Popup actions
Add a Show Popup action
Add the action
Use the following steps to add the action to a workflow.
How to add an action to a workflow
How to add an action to a workflow
Click the ‘plus’ symbol on the workflow path at the point you want to insert the action. This opens the action menu slide-over.
Either:
Search for the action using the Search field above the actions in the menu.
Locate a Recently Used action in the top section of the menu.
Navigate to the action within menu: Core actions are listed under Actions, while Plugin actions are contained within their associated integration.
Select the desired action to insert it. This reveals the action’s configuration panel.
Use the Name field to name the action. This can help users to understand your workflow at a glance. (optional)
Use the Description field to add information describing the action. This can help users wanting to understand how your workflow functions (optional).
Configure the action
Use the following steps to configure the action.
Set values for the fields: Web Client Instance; User Email; Content
Click back in the main view to hide the slide-over.
Delete a Show Popup action
Use the following steps to remove the action from your workflow:
How to remove an action from a workflow
How to remove an action from a workflow
Access the workflow in draft mode to edit it.
Either:
hover your mouse cursor over the action, and then click the red cross that appears over the top-right corner of the action to delete it. Or:
click on the action to open the action slide-over. Click the red 'Delete Step’ button to remove the action from your workflow.
Click Publish in the top-right to commit your changes.
Take care when deleting an action to also remove any logic using its outputs: workflow steps may function incorrectly or break if they attempt to evaluate an output of a deleted action.
Was this helpful?
Still need help? Share an idea