Quickstart Guide

This page is about Easy Integrations for Jira Cloud. Using Jira On-Prem? Click the On-Prem button above.

Welcome to Easy Integrations for Jira Cloud, a powerful tool that allows you to effortlessly manage an unlimited number of integrations. This guide will walk you through the process of creating your first integration step by step, ensuring a smooth start to your integration journey.

Step 1: Create a Credential

Begin by establishing a credential, a vital step for authorizing your REST API integration. This step can be skipped if your REST API does not require authorization.

Navigate to Apps > Manage your apps > Easy Integrations configuration > Credentials.
Click Create.
Provide a credential name. This name will be used later to select a credential while configuring an integration.
Select the target Authorization Type and fill in the required fills for the authorization type.

Step 2: Make an Integration

After you have completed the credential for the authorization, you can create a Rest API integration.

Navigate to Apps > Manage your apps > Easy Integrations configuration > Listeners.
Click Add listener.
Give the listener a name.
Click Add event and select the events to track (e.g., "Issue updated" and JQL: "issuetype = Task").
- Only a subset of JQL clauses is supported. Refer to Listeners and https://developer.atlassian.com/cloud/jira/platform/webhooks/#supported-jql-queries for more information.
Click Add action and select Call Rest API.
Give the action a name.
Write the action parameters script. Check out an example below:

Action parameters:

var parameters = {};
parameters['issue summary'] = data.event.issue.fields.summary;
parameters['issue status'] = data.event.issue.fields.status.name;
return parameters;

Write the URL.
Select the HTTP Method.
Write headers. For example:

Action parameters:

Accept=*/*
Cache-Control=no-cache
Content-Type=application/json

Select the Authorization type and, if it's not None, select the Credential.
Write the REST API body in JSON format. Here's an example body, where {{issue summary}} and {{issue status}} are replaced by action parameters:

Action parameters:

{
    "name": "{{issue summary}}",
    "attributes": [
        {
            "attributeId": "41",
            "attributeValue": "{{issue status}}"
        },
        {
            "attributeId": "121",
            "attributeValue": 12.5
        }
    ],
    "systemFields": [
        {
            "fieldName": "asset.status",
            "value": "1"
        },
        {
            "fieldName": "asset.substatus",
            "value": "1"
        }
    ],
    "formId": 148,
    "attachments": null
}

Click OK to add the action.
Click Submit to save the Listener.

Now it's time to update an issue! Please note that the issue must be of the Task issue type. To observe what happened, you can navigate to Apps > Manage your apps > Easy Integrations configuration > Execution Logs. Happy integrating!