Using Dialogs with Workbot
Workbot can be used to invoke Slack Dialogs; an awesome Slack feature that allows you to elicit info in a more interactive way.
Workbot can invoke dialogs to, say, collect info from a user to open a ticket in Github, amongst other things.
To create a dialog workflow, you need 3 recipes to perform 3 high-level functions:
Trigger a post dialog recipe When triggered, the action in this recipe triggers the second recipe which in turn invokes the dialog. We'll call this the Trigger recipe.
Post dialog When triggered, the action in this recipe posts the dialog.
Execute actions When the dialog is submitted, the actions in this recipe executes the follow-up actions.
From a recipe standpoint, the first recipe triggers the Trigger recipe, which in turn triggers the Execute actions recipe.
This is because invoking dialogs requires
Trigger ID, something that's only generated from button or menu option click events on Slack.
Triggering a post dialog recipe
To trigger a post dialog recipe, use either the Post command reply or Post message Workbot actions.
Regardless of which Workbot action you choose, the dialog recipe can be triggered via 2 methods:
The Submit button command field is especially important - this command will trigger the recipe that posts the dialog (i.e. the Trigger recipe).
2. Menu options
The Submit menu option command field is especially important - this command will trigger the recipe that posts the dialog (i.e. the Trigger recipe)
Clicking either buttons or menu options in Slack triggers an event that comes with a
Trigger ID, a parameter necessary for invoking dialogs.
In the example above, both the button and the menu option sends a Workbot command to
collect issue details.
Posting a dialog
To ensure that the dialog in this recipe is the one to be invoked, the submit button or menu option commands in the Trigger recipe must map to the Post command trigger in this post dialog recipe.
The Post dialog recipe uses the Workbot Post command trigger to receive commands from the buttons or menu options in the trigger recipe.
In this example Post dialog recipe, both the submit button and submit menu option commands
collect issue details are identical to the Post dialog trigger
collect issue details.
Setting up the post dialog
Use the Post dialog action to set up the post dialog.
The following table lists the available fields in the Post dialog action.
|Field||Explanation||What goes in here|
|Trigger ID||The ID of a submit button or submit menu option triggered event.||Use the Trigger ID pill from Post command trigger.|
|Callback ID||Identifier for the dialog. Maximum length of 255 characters.||
Pass command input values from the Submit button or Submit menu option commands defined in the trigger recipe.
Ensure that the parameter names in the trigger recipe match the command input fields in the recipe that posts the dialog.
|Dialog title||The title of the invoked dialog. Maximum length of 24 characters.||
Explain the purpose of the dialog, e.g.|
Create a ticket
|Submit button label||Text label to display on the dialog Submit button. Single word input only.||Defaults to Submit when left blank. All dialogs will have a Cancel button by default.|
|Submit button command||Workbot command to execute when Slack user clicks on the Submit button in the dialog||Use a Workbot command that matches the Post command trigger of the recipe to execute.|
|Dialog form fields||this will be automatically generated upon selecting a command in Submit button command input field. Max of 5 fields||
This defines the fields that appear in the dialog.
Modify this to include hints, error handling, picklist options, etc. for your dialog.
Do not change the "name" values as they should match that of the command input fields of the recipe executed from the Submit button command above. See the example JSON from the Post dialog recipe.
The Submit button command field is especially important - this command will trigger the recipe that executes the actions (i.e. the Execute actions recipe).
To ensure that this recipe is the one to be executed by the dialog, the submit button command in the Post dialog recipe must map to this recipe's Post command trigger.
The last recipe (responsible for executing follow-up actions) uses the Workbot Post command trigger to receive commands from the submit button command in the Post dialog recipe.
Common pitfalls when using dialogs
Given that dialogs involve using multiple recipes, it's normal to encounter some issues at the start. Here are some common pitfalls when using dialogs.
1. Using the same Post command trigger words on more than 1 recipe.
Ensure that the combination of all 3 App, Action, and Action data of Post command triggers in any of your recipes are unique across your Workato account. Any submit button or submit menu option command should only be mapped to 1 recipe.
For example, the recipe above should be the only recipe in that Workato account to have
github report bug as its Post command trigger.
2. Submit button / menu option commands incorrectly mapped
Ensure that the Submit button command and/or Submit menu option command of a recipe is correctly mapped to the Post command trigger of the secondary (or tertiary) recipe.
3. Incorrect mapping of dialog form fields with command input fields of subsequently triggered recipe
Ensure that dialog form field names from the Post dialog recipe correspond with the command input fields of the subsequently triggered recipe.
Try it out!