Skip to main content

Jira Integration

Send data from Enboarder to create tickets in Jira!

Chris Jones avatar
Written by Chris Jones
Updated over 12 months ago

Do you want to automate the creation of tickets in Jira by pushing data from Enboarder? Enboarder's integration with Jira utilizes a Push model where Enboarder sends post data in a JSON format to Jira via Enboarder's webhook module.

Sending to Jira via a webhook

  • Add a webhook module in the workflow sequence

  • Write a description of the webhook (Create a user-friendly name)

  • Enter the Atlassian URL: e.g. https://{your_jira_domain_name}.atlassian.net/rest/api/2/issue/.
    ​replace {your_jira_domain_name} in the above example with your Jira URL.

  • Select Method as Post (data to URL).

  • Add two headers:

    • Content-Type header value as application/json

    • Authorization header value as Bearer {API token}

NOTE: To create an API token in Jira, refer to this Atlassian help article

  • Complete the detail in the body in the below format:

{
  "fields": {
    "project": {
      "key": "AP"
    },
    "summary": "{{newhire_name}} New Joiner",
    "customfield_11085": "{{newhire_email}}   {{newhire_mobile}}",
    "labels": [
      "Enboarder"
    ],
    "description": "IT Order",
    "customfield_11084": "{{direct_manager_email}}",
    "customfield_11083": "{{buddy_email}}",
    "customfield_10728": "{{category / location}}",
    "customfield_11082": "{{category / team}}",
    "issuetype": {
      "name": "Task"
    }
  }
}

Sending to Jira via OAuth 2.0

Enabling OAuth 2.0 (3LO)

Before you can implement OAuth 2.0 (3LO) for Enboarder, you will need to enable it for Enboarder in Jira's app management:

  • First login as an admin user in Jira. Then open a second tab and login to https://developer.atlassian.com. You will automatically login to the developer site. Click on your profile icon (on right top) and select Developer Console

  • On the Developer console screen, you will see your existing apps.

  • Click on Create app and then select OAuth 2.0 (3LO) integration

  • On this screen, provide an App name (eg Enboarder) and then click on Create

  • The system will create an app and redirect you to app home page

  • Click on Permissions and then Add permission for these APIs

  • Click Add for Jira platform REST API then click Configure.

  • Click on Add to add desired scopes for your app

Note - Please make sure to add View user profiles permission otherwise it will not work

  • Once all permissions are provided, Please click into the Authorization tab and then click Configure

  • At bottom of the Authorization page, after saving the changes, you will see technical details of scopes and URLs in the Authorization URL Generator section

  • Copy these URLs, and in a text editor you need to identify the scope attributes in the URL. For example:

https://auth.atlassian.com/authorize?audience=api.atlassian.com&client_id=7tURd6IK1qrTL5KjlMLSRMUKh4iOy6vp&scope=read%3Ajira-work%20write%3Ajira-work%20read%3Ajira-user&redirect_uri=https%3A%2F%2Fauth.enboarder.com%2Foauth&state=${YOUR_USER_BOUND_VALUE}&response_type=code&prompt=consent

  • Copy these scope values in a seperate line like below :

read%3Ajira-work%20write%3Ajira-work%20read%3Ajira-user

  • Now replace %3A character with colon : and %20 with space. your final list will look like the below:

read:jira-work write:jira-work read:jira-user

  • Similarly, process the other URLs to create a final list of scopes. This is required while setting up the Jira tile in Enboarder.

Note - scope values can also be referred to from the below site:

https://developer.atlassian.com/cloud/jira/service-desk/scopes/

  • Finally, click into Settings. You can optionally add a description and logo for this newly created app. Please scroll down and note down the below values and keep these handy. These values are required during integration set up in Enboarder.

    • Client ID

    • Secret

Setting up the Jira Tile in Enboarder

  • Log in to Enboarder as an admin user and go to Settings → Integration → App centre

  • Click on the Jira tile

  • Click on Add Integration

  • On the next screen, you will need to add the required scopes. Enboarder will add the below scopes as default:

    • read:jira-user

    • read:jira-work

    • offline_access

  • If there are additional scopes that you added while setting up the Jira OAuth app, please add them here

  • Enter tje client id snd secret key that you have generated while registering the app in Jira and click on Add Integration

  • You will be redirected to Jira to enter your Jira credentials. Once logged in, a request for information access will be asked. Once this is allowed, the integration is completed

Send Data to Jira via Webhook

Construct the request URL

Requests that use OAuth 2.0 (3LO) are made via api.atlassian.com (not https://your-domain.atlassian.net). Construct your request URL using the following structure:

https://api.atlassian.com/ex/jira/{cloudid}/{api}

where:

  • {cloudid} is the cloudid for your site. For example, 11223344-a1b2-3b33-c444-def123456789.

  • {api} is the base path and name of the API. For example, /rest/api/3/issue for the issue endpoint in the Jira REST API.

Your request URL should look something like this (using the examples above):

https://api.atlassian.com/ex/jira/11223344-a1b2-3b33-c444-def123456789/rest/api/3/issue

Note that if you are copying the examples in the Jira REST API documentation, you will need to amend the example URLs as they currently use https://your-domain.atlassian.net/{api} not api.atlassian.com/ex/jira/{cloudid}/{api}.

When constructing the webhook in Enboarder, put the URL that you have constructed and in the authentication option, select Jira Software

Use the details at the top of this article that define how to add the payload details into your webhook.

More resources:

Got questions? 🧐 Start a chat with the team in the top right of any Enboarder page! ✔

Did this answer your question?