Workbot for Microsoft Teams triggers ​

Workbot for Microsoft Teams has the following triggers:

• New command trigger
• New help message trigger
• Tab opened trigger
• New message trigger (beta)

New command trigger ​

Workbot commands allow you to trigger recipes from Microsoft Teams. These recipes can then perform actions in your apps (for example, creating new ServiceNow tickets, or listing Salesforce opportunities).

This means you can from perform actions in your apps from within Microsoft Teams.

Sending a 'newissue' command with additional parameters in Teams, then receiving a reply

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

A Workbot recipe with a Workbot command trigger

Configuring the command ​

Example 'newissue' command

Input ​

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

Command name ​

Workbot commands can invoke their recipes by:

1. Sending the command name in a direct message to Workbot, for example, newissue
2. Sending the command name in a channel and tagging Workbot, for example, @workbot newissue
3. Submitting a button with the command name configured: A button can be configured to invoke a Workbot command of another recipe

The 'Create issue' button invokes the 'newissue' command and executes the recipe when submitted

Parameters ​

Each parameter can store additional data that can be used as datapills in follow-up recipe actions.

For example, to create an incident in ServiceNow, you may want to prompt users for additional info like Urgency, Summary, and Description. By adding Urgency, Summary, and Description as parameters, Workbot will open a task module and prompt the user for each parameter.

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.

Sending a 'newissue' command with additional parameters Urgency, Summary, and Description

Defining parameters ​

3 parameters configured for the 'newissue' command

When you define parameters, Workbot opens a task module to collect each parameter's value from the user.

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

Adding a new parameter

By configuring the parameter, you can control how the users interact with the parameter in the task module.

Configuring a parameter

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

Advanced methods to pass parameter values ​

Parameter values can also be passed by buttons and task modules as they invoke a Workbot command. Typically, you use parameters to pass context to the invoked Workbot recipe.

The 'Re-open issue' button not only invokes the 'reopen_issue' command - it's also passing parameters!

The 'Re-open issue' button is configured to pass the 'sys_id' so that the 'reopen_issue' recipe knows which issue to re-open

Another way to pass a parameter is by using a pick list Choice parameter.

The choice parameter will take its value from a choice (if it's chosen)

The choice parameter is passed when a button from the same message is submitted (along with any other parameters the button may have).

The 'Next' button also passes the 'opportunity_id' of 'Google' onto the command recipe that it invokes

Files for Enterprise Workbot ​

End users can upload files to Enterprise Workbots when file parameters are defined in the bot commands. These files are uploaded to the user's OneDrive for Business storage, and its data can then be used in follow-up recipe actions. The file portion of the trigger output looks like this:

New help message trigger ​

The New help message trigger executes when a help message is sent to your bot via DM or channel (when mentioned by the user, e.g. "@workbot help"). Use this trigger if you want to fully customize your bot's help message response, instead of utilizing the Workbot default help message.

It is recommended to pair this trigger with the Post reply action. The reply will then become the help message users will see when invoking help for your bot.

Only 1 New help message trigger recipe can be active at a time for each bot.

Reasons to use New help message trigger ​

It is highly recommended to customize your bot's help message based on its unique functionality. This is done by responding to a New help message event with a Post reply. The context contained within the trigger can be used to:

• Personalize the message to the user by using User ID
• Show different help messages if the user is the bot admin or an end-user by using Is bot admin?
• Provide alternative help messages using text that the user submits along with their help command, e.g. help Salesforce
• Display bot commands, personal connections, and links to bot recipes and jobs

With the customized help message now defined within a Post reply action, you are now able to:

• Describe your bot's unique functionality in greater detail
• Include information from other apps (e.g. Salesforce, ServiceNow, Jira) that can be scoped to the user
• Build multi-step help flows that can open task modules or bring users to specific tabs

Inputs ​

No inputs required.

Outputs ​

Help message priority ​

Help messages follow the following priority:

1. Custom help in recipe
2. Default help

Tab opened trigger ​

This trigger executes when a user opens a tab in your enterprise Workbot. To learn more about how tabs work, see Tabs.

Input ​

Output ​

New message trigger ​

New message trigger

The New message trigger activates when a user sends a direct message (DM) to Workbot or mentions Workbot in a channel, provided there are no active new command triggers that match the user's message. If no specific command triggers are set up to respond to that message, the New message trigger runs.

For example, if you send @workbot hello to Workbot and have no active recipes configured with the hello command, the New message trigger picks up the event and proceeds with the workflow defined in your recipe. This trigger takes precedence over the default Command not found response.

This trigger is compatible with Post message and Post simple message actions. Use it to customize your Workbot’s response to a new message. You can have multiple recipes with the New message trigger active at the same time. Additionally, you can use trigger conditions to filter for a specific channel.

Input ​

This trigger does not require user input. However, you can set a trigger condition to configure Workbot to respond to messages in one or more specific channels only.

Output ​

How it works ​

This trigger is useful in situations where your users interact with Workbot, but their input does not match any existing commands. It enables you to create more interactive and dynamic conversations between Workbot and your users.

The following example pairs the New message trigger with a Post message action. This action allows users to complete their tasks by selecting an option, such as filing a ticket, searching for records, or talking to support.

How to obtain a channel ID ​

A channel ID corresponds to a specific channel in Microsoft Teams. You can use the channel ID to configure trigger conditions that filter events by channel and control which channels prompt a response from Workbot. This ensures Workbot's actions are relevant to the context of those channels.

Complete the following steps to obtain a channel ID from Microsoft Teams.

https://teams.microsoft.com/l/channel/19%3Aae37e692418942c28c2c97cd38493cf5%40thread.tacv2/%5BDocs%5D%20Test?groupId=55563081-256e-4922-8f4e-e2a760294320&tenantId=76a89289-583c-40a2-9709-e076eed5d680

19%3Aae37e692418942c28c2c97cd38493cf5%40thread.tacv2

19:ae37e692418942c28c2c97cd38493cf5@thread.tacv2

19:ae37e692418942c28c2c97cd38493cf5@thread.tacv2

19:ae37e692418942c28c2c97cd38493cf5