Use Automation with Workato
The features described in this article are currently rolling out and may not be available in your Jira Service Management project yet. Keep an eye on our release notes to find out when the feature will be available.
The Workato integration with Automation is only available to Jira Service Management Cloud customers on Premium or Enterprise plans. Find out how to upgrade your plan.
Atlassian supports an integration with Workato, allowing you to create a connection between your automation rules and Workato account. Read about connections in Automation.
In Jira Automation, rules are made up of a series of triggers, conditions, and actions. The Trigger Workato recipe action allows you to run an existing Workato recipe at a specific point in a rule.
Before you can use the Trigger Workato recipe action for the first time, you’ll need to create a connection with Workato.
Connect to Workato
Things to remember
To use Workato with Jira Automation:
you need the Workato API Platform enabled. Read more about the Workato API Platform.
you need to generate a Developer API token and a Platform API/auth token from Workato, then use them to create a Workato connection from Jira Automation.
Different Workato connections can be used, or a single connection re-used across multiple Workato actions in the same rule.
Once the Workato action is added and a new connection is made, recipe changes can only be made by the admin who created the connection. However, any admin with rule editing permissions can change the payload configuration. Review the recipes available with the connection to ensure you’re aware of what data may be shared.
Generate a developer API token
To generate a developer API token, you need to be a Workato admin. Read more about Workato collaborator roles.
Log into your Workato account.
Create a client role. Before you save your client role:
Select Projects.
Under Project assets, expand Recipes.
Check the box next to List | GET /api/recipes.
Select Tools.
Under API Platform, expand Collections & endpoints.
Check the box next to List endpoints in a collection | GET /api/api_endpoints.
Create an API client. Before you save your API client:
Under Client role, select the client role you created earlier.
Store the API token that displays after creating your API client somewhere safe.
Generate a Platform API or auth token
Go to Workato.
Before proceeding, we recommend that you create an API recipe collection for Jira Automation.
If you created a collection for Jira Automation, add it under API collections to include.
Under Authentication method, select Auth token.
Copy the auth token that displays and save it somewhere safe.
Connect to Workato from an automation rule
You can create a connection with Workato by creating an automation rule that uses the Trigger Workato recipe action. This action triggers a Workato recipe that runs as part of your automation rule. You can re-use the same connection, or use different connections for any number of Workato actions in your rule.
You must be a Jira admin to create a connection between Workato and Jira Automation.
From your service project, select Project settings, then Automation.
Select Create rule and add a trigger.
Select Add component and find the Trigger Workato recipe action by searching for ‘Workato’ in the search box.
When prompted to connect to Workato, select Connect.
Complete the form with the details you received when you registered the API client in Workato.
Enter a Connection name.
Enter a Developer API token from Workato. Instructions for generating a developer API token are above.
Enter your Base URL. Read more about defining a base URL.
Enter a Platform API or auth token from Workato. Instructions for generating an auth token are above.
Select Connect.
Enter details for the Trigger Workato recipe action
Things to remember
Data from any recipe associated with a Workato connection created from your automation rule may be exposed to the user who triggers the rule. So when building your automation rule, you should be mindful of the data or information that may be exposed through smart values in subsequent rule actions.
Ensure the schema validation for your recipe endpoint is toggled off in your endpoint settings (regardless of the type of endpoint method used), so that the automation action can call the endpoint successfully. Read about configuring API recipe endpoints.
We recommend using POST as the HTTP verb method for passing request data and recipe inputs (avoid using GET where possible when you need to pass request data). Read about HTTP methods.
Automation has an HTTP request timeout of 30 seconds for outgoing webhooks. Complex Workato recipes that run for longer than 30 seconds may cause the rule to time out. Read about automation service limits.
Once the connection is established, you’ll be able to use the Trigger Workato recipe action in your rule.
Select a recipe: to use this action, you must select the Workato recipe you want to trigger from the rule. Only recipes with a new API endpoint as the recipe trigger will be listed. If no recipes are available, create some in Workato or use a different connection. Read about API recipes.
Enter information about headers, request schema, and path parameters: this is optional but available if the chosen recipe accepts them as a method of recipe input. The recipe schema must be followed correctly for these inputs to work.
Headers and path parameters – you can enter key value pairs as an input if your recipe expects it. We suggest using the request schema if you have complex nesting requirements. To find the header parameters, check the recipe’s request structure. To find the path parameters, check the recipe’s request endpoint.
Request schema – you can craft a request schema payload using JSON if your recipe expects it. To find the request bodies schema, check the recipe’s request structure.
Select Next when you’re done.
Limitations
Although path parameters can have a schema, only simple text or number values are supported.
Query parameters are not supported. A request schema of a GET request will be sent over as request payload.
Only endpoints returning Content-type JSON are supported.
Smart values
You can use these smart values to access Workato request response data in subsequent rule actions.
{{workatoResponse.statusCode}} – Returns the response code.{{workatoResponse.headers}} – Returns the response headers that can be accessed using dot notation.{{workatoResponse.body}} – Returns the response body that can be accessed using dot notation (if a JSON object).{{workatoResponse.body.nested_field_name}} – Returns nested values in the response body that can be accessed using dot notation (if a JSON object).
Was this helpful?