Skip to main content
Core Actions

Ask

Reference documentation for using the Ask action

Written By Support Channel

Last updated Over 1 year ago

Overview of the Ask action

The Ask action allows a workflow to prompt a user for input during its execution. This creates an interactive step where the workflow pauses until the required information is provided which can then be used in future actions.

Purpose

To collect input from a user during a workflow

Parameters

1 Chat Client Instance
1 User Email
1 Message to Send

Output

User response

Understanding the Ask action

The Ask action makes workflows more interactive by allowing user input where required. The action pauses the workflow and sends a question to a specific user and only continues once a response has been submitted.

Chat Client Instance

Select the Chat Client instance where the message will be sent to

User Email

Enter the email address of the user who should receive the card. This must be a valid user within the selected Chat Client instance.

Message to Send

The message that the action will send to the user which prompts them to provide response.

Working with Ask action

The action is particularly useful in scenarios where additional information is needed such as a ticket ID, confirming a request, or entering data that wasn’t initially needed.

Once the user responds, the workflow captures the answer and stores it in a named variable. That value can then be used later in the workflow.

Create and manage Ask actions

Add a Ask action

Add the action

Use the following steps to add the action to a workflow.

  1. Click the ‘plus’ symbol on the workflow path at the point you want to insert the action. This opens the action menu slide-over.

  2. 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.

  3. Select the desired action to insert it. This reveals the action’s configuration panel.

  4. Use the Name field to name the action. This can help users to understand your workflow at a glance. (optional)

  5. 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.

  1. Set the Chat Client Instance, User Email and Message to Send fields.

  2. Click back in the main view to hide the slide-over.

Delete a Ask action

Use the following steps to remove the action from your workflow:

  1. Access the workflow in draft mode to edit it.

  2. 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.

  3. 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