Access forms data with the Forms API in Jira Cloud
Platform Notice: Cloud Only - This article only applies to Atlassian products on the cloud platform.
Summary
When using the 'Forms submitted' trigger, we are able to use the {{forms.last}} smart value. For other triggers, we must use the Jira Forms API to pull the information we need.
Solution
First step - Authentication
The first step is to create an API Token to be used for the authentication process.
Second step - Getting a list of forms on the work item
Now, we must list all the forms we have on a given work item. For that, we can use the following API call along with a 'Send Web Request' action:
GET https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{WorkItemIdOrKey}/formNeeded Headers:
Authorization: Basic <token>
X-ExperimentalApi: opt-inDelay execution of subsequent rule actions until we've received a response for this web request, so we can work with the values later.
Third step: Log actions!
Log actions are an essential part of all automation rules. They let us inspect variable values, action results, and so on. Here, it is a good idea to log the response from the previous action.
[
{
"id": "bc1bc47f-b192-4bde-8467-d14a5bcc9731",
"formTemplate": {
"id": "aafb5779-f76f-408f-8cc8-7e9077bc2e08"
},
"internal": false,
"submitted": true,
"lock": false,
"name": "2/14/2023 new form",
"updated": "2025-01-28T18:55:32.115Z"
},
{
"id": "53af9d19-c61d-4f61-bc36-f08891af2db7",
"formTemplate": {
"id": "b9f12dbf-7955-471a-8808-60f628f52058"
},
"internal": true,
"submitted": true,
"lock": false,
"name": "Guest wifi account form",
"updated": "2025-01-09T14:03:42.125Z"
},
{
"id": "b13e2d21-bc20-4df5-bbc8-5d199e4fd40c",
"formTemplate": {
"id": "9e63f619-03df-488e-b1c1-e1084adee4dc"
},
"internal": true,
"submitted": true,
"lock": false,
"name": "Nested form sections example",
"updated": "2025-01-31T13:02:55.289Z"
}
]Fourth step - Conditions and branching
As you can see, we have three forms attached here. There is a simple check you can add to make sure the rule will only proceed if the work item has at least one form attached to it:
Now, we will add a branch action to loop through each of the forms (If you are sure that your work item will have only one form, this is not needed):
In this example, we're looking for a specific form named '2/14/2023 new form', so we will add a simple smart values condition to proceed only with the form we need:
Last step: Getting the form values
There is a simplified call that we can now make to get the form answers directly: Get form answers API
The returned data will look something like this:
[
{
"label": "test pdf date",
"answer": ""
},
{
"label": "what the form",
"fieldKey": "assignee",
"answer": "Wesley Nery"
},
{
"label": "Unlinked field",
"answer": "option1",
"choice": 1
},
{
"label": "This is linked to that field that prevents issue creation",
"fieldKey": "customfield_10324",
"answer": "Yes",
"choice": 10465
},
{
"label": "This is the description from the ticket",
"fieldKey": "description",
"answer": "something"
}
]The answers will keep the order of your form's template. This means that if the form's structure does not change, for example, above, we can get the value for our 'Unlinked field' by programmatically getting the value in the third position of the array (here, the first position is actually 0, so the third position is position 2):
{{fromJson(webResponse.body).get(2).answer}}Now, if you want a more future-proof method, you can create a variable and use some smart value magic to return the answer if the label key matches the field you need.
{{#webResponse.body}}
{{#if(equals(label,"Unlinked field"))}}{{answer}}{{/}}
{{/webResponse.body}}Was this helpful?