SIGN INCONTACT US

Integrate with Jira

You can trigger a process from a Jira issue or create a Jira ticket in a Jira project as a step in a workflow.

Suggest Edits

Create a Jira issue from a process

Before you begin

  • Make sure to have the key of your Jira project at hand. You can find it in your Jira project overview.
  • Understand how data references work. See Use data references. This will help you use the captured data in the workflow steps.

🚧

Good to know: Check out our ready-made templates available when you add a step and select Templates > 3rd party templates. You can use the templates to create a set of pre-configured steps.
Need a specific template? Click the Contact us button in the top right of the page and let us know.

Create an issue in Jira

  1. In Jira go to Settings > Atlassian Account Settings > Security > Create and Manage API tokens.
  2. Create your Jira token and copy it to the clipboard.
  3. You need the token to be base64-encoded (in the format of useremail:api_token). Base64-encode the string by using a tool like https://base64encode.org. Before encoding your string will look like the following: \[email protected]:12345\
  4. In Next Matter select the workflow that should integrate with Jira, and add a new integration step.
  5. Click Settings and enter the following details:
  • Method: POST
  • URL: https://JIRA_SUBDOMAIN.atlassian.net/rest/api/latest/issue/
  • Headers: Content-Type: application/json
  • Headers: Authorization: Basic JIRA_API_KEY
  • Body might look like the following:
{  
   "fields":{  
      "project": {  
         "key": "JIRA_PROJECT_KEY"  
       },  
       "summary": "SUMMARY", //this can be a data reference from previous steps 
       "description": "DESCRIPTION",  
       "issuetype": {  
          "name": "TASK"  //can also be a bug
       }  
   }  
}

Start a process from Jira Service Desk ticket or Jira issue

Before you begin

  • Make sure Next Matter is allow-listed in Jira. See Jira documentation.
  • Note down the ID of the workflow that will be triggered with the first workflow. You can get the ID by clicking the workflow and copying the number from the URL in your browser.

Start a process from Jira Service Desk

  1. In Jira Service Desk, go to Project Settings > Automation.
  2. Click Create rule.
  3. Define the When trigger as Issue created.
  4. Add a Then action and define it as Send web request.
  5. In the Send web request section, enter the following details:
  • Webhook URL: https://core.nextmatter.com/api/instances/
  • Headers: Content-Type: application/json
  • Headers: Authorizations API-Key NEXT_MATTER_API_KEY
  • Method: POST
  • Webhook body: Custom data
  • Custom data: 
{"name": "{{issue.key}}",
 "process": "https://core.nextmatter.com/api/processes/ID_OF_THE_PROCESS/" }

Every time that a Jira issue for this project is created, it will launch the specified Next Matter workflow and use the issue-key as the name of the instance.

(Optional) Push additional data from Jira to the first step in Next Matter workflow

If you want to create a workflow with some Jira data in it, go back to the automation rule you created in Jira, and change the following:

  1. In Jira, automation settings add an And to your rule. Define the And**** as an action to complete a subsequent step.
  2. Configure the following attributes for the And:
  • URL: https://core.nextmatter.com/api/instances/{{webhookResponse.body.id}}/complete_step/
  • Headers: Content-Type: application/json
  • Headers: Authorizations API-Key NEXT_MATTER_API_KEY
  • Method: POST
  • Webhook body: Custom data
  • Custom data - you can map Jira issue information onto corresponding Next Matter actions. Next Matter actions can be identified with the IDs displayed in the editor. The payload might look like the following
{"step_id":33890,
  "actions":[
    {"action_id":112505,
    "input_object":
    {
    "inputValue":"{{issue.created.format("dd/MM/yyyy")}}"}
    },
  {"action_id":112468,
   "input_object": 
   {"inputValue":"{{issue.description}}"}},
  {"action_id":112478,
   "input_object": 
  {
    "inputValue":"attachment.filename", 
    "action_id":112479,
    "input_object": "inputValue":"{{issue.url}}"
  }
    },
    {"action_id":112579,
    "input_objectinputValue":"{{attachment.author.displayName}}"}
  }
    ]
  }
Where is the action ID
  1. In your left-hand navigation, click the Workflows icon.
  2. Hover over the follow-up workflow and click on the menu icon.
  3. Click Workflow.
  4. Click the step to which you'd like to send data.
  5. Click the ID icon for the field to which you want to copy data.
  6. Copy Form field ID.
Where is the step ID
  1. In your left-hand navigation, click the Workflows icon.
  2. Hover over the follow-up workflow and click on the menu icon.
  3. Click Edit workflow.
  4. Click the step to which you'd like to send data.
  5. Copy the step ID. It's the last number in the URL you see in your browser.

If you've configured everything, the result is a newly created instance and a filled-out first step.

As a follow-up, you can make updates to your Jira issue, for example, you can add a comment that is sent to the user that raised the issue originally with an integration step.

You can refer to Jira documentation to see which values you can send to the Next Matter workflow.

Updated 3 months ago