Workbot command trigger

Workbot commands allow you to trigger recipes from Workplace. These recipes can then perform actions in your apps (e.g. creating new ServiceNow tickets, listing Salesforce opportunities).

This means you can from perform actions in your apps from within Workplace!

Command example Sending a 'new_issue' command with additional parameters in Workplace, then receiving a reply

When a command is sent to Workbot in Workplace, it will trigger the Workbot recipe and execute its actions.

Command recipe A Workbot recipe with a Workbot command trigger

Configuring the command

New command Example 'new_issue' command

Input fields

The table below lists the input fields in the trigger and what they do.

Input field Description
Command name Name of the command.
Parameters Parameter can store additional data that can be used as datapills in follow-up recipe actions.
Command hint Display this instead of command name in response to help messages.
Hidden command If Yes, command will not show up as a command in help messages. Defaults to No.

Command name

Workbot commands can invoke their recipes by:

  1. Sending the command name in a direct message to Workbot, e.g. new_issue
  2. Sending the command name in a channel and tagging Workbot, e.g. @workbot new_issue
  3. Submitting a command button with the command name configured: Command name in button
    A button can be configured to invoke another Workbot recipe
  4. Submitting a quick reply button with the command name configured: Command name in button
    Quick reply button configured to invoke another Workbot recipe
    Command name in button example The 'Next' button invokes the 'new_issue' command and executes the recipe when submitted

Parameters

Commands can also prompt users for additional parameters. For example, to create a new Github ticket, the user should provide the title and description of the incident.

In this case, you can add 2 parameters; title & description. When the command is invoked, Workbot will prompt the user for each parameter.

Collecting parameters Workbot can ask users for info if you specify additional parameters in your command

Users can also skip the prompts by supplying the parameters together with the command.

Command with in-line parameters Sending a 'new_issue' command with additional parameters Title and Description

Defining parameters

Adding parameters 2 parameters added to command

To add a parameter, click on the +Add parameter button under the Parameters section of a Workbot command trigger.

Adding a new parameter Adding a new parameter

Configure the parameter by specfying the parameter name, the data type (typically string) and so on.

Parameter form empty Configuring a parameter

The table below describes in further detail what each parameter configuration field does.

Input field Description
Name Name of the parameter. This is the name you use to reference the parameter in:
  • In-line commands

  • Buttons
  • Quick reply buttons
Data type Data type of the parameter. Currently only supports string.
Optional? If set to Yes, users can skip this input. If set to No, users are required to provide this input.
Options If the display name and the value are different, separate the two by a colon, e.g. High:1,Medium:2,Low:3.
Advanced methods to pass parameter values

Parameter values can also be passed by buttons and quick reply buttons when they invoke a downstream Workbot command recipe. Typically, you use parameters to pass additional context for downstream Workbot recipe to use.

Command name in button A 'Duplicate incident' button which invokes the 'new_issue' recipe, passing it context about the incident to be duplicated.

Command name in quick reply button A 'Duplicate incident' quick reply button which invokes the 'new_issue' recipe, passing it context about the incident to be duplicated.

Learn more

results matching ""

    No results matching ""