Connecting Jira Service Management to Y Meadows

Jira Service Management can be used as message source. All Jira Service Management projects are treated as directories in Y Meadows and all issues in the project are treated as messages.

Jira is available in 2 distributions: Cloud, which is hosted by Atlassian, and Data Center which is hosted by client organization. Typically Cloud installs have URLs like acme.atlassian.net and Data Center installs have URLs like jira.acme.com. Our instructions are primarily geared to Cloud customers. We will note where things differ for Data Center customers.

Step 1 - Initial setup

Go to you Jira Service Management main page.

Check the URL of the settings page in your browser. It will be something like: https://undergroundairline.atlassian.net/jira/your-work

take the part between https:// and the next /, e.g. undergroundairline.atlassian.net . Copy this down, it will be used in a later step when we ask you for the “domain”.

Step 2 - Create API key on Jira side

Data Center customers should skip this step.

Go to https://id.atlassian.com/manage-profile/security/api-tokens

Click on Create API Token

Enter token name, e.g. Y Meadows API Token

Click on Copy to copy token and save it. You will need it in a later step when we ask you for the “API Key”

Step 3 - Set up the connection on the Y Meadows side

Create a new connection based on Jira Service Management Issues Webhook connection type.

Enter the Domain that you got from Step 1 as Jira Service Management Domain.

Enter the email address that has access to Jira Service Management as User Email Address.

Data Center customers should use the user’s username rather than the address. These might be the same or they might differ.

Enter the API Key that you got from Step 2 as API Key.

Data Center customers should use the password of the user whose username they entered in the User Email Address field as the API Key.

Make up a “password” and enter it as Webhook Secret. Note it down as you will need this “Webhook Secret” in a future step.

Data Center customers MUST leave Webhook Secret blank.

You can use an online password generator like Secure Password Generator 🔑 | Online/Client-side.

The Webhook Secret is included into each webhook request by Jira Webhook Automation. The Y Meadows will verify that the message came from Jira Webhook Automation by comparing this value with one that is assign to the source.

Save the new connection.

Take a look at the URL in the browser. It will be something like https://tierzero-qa.ymeadows.com/components/connections/6caa5637-67e7-46ce-a002-7c3593e0da41 . That last portion, 6caa5637-67e7-46ce-a002-7c3593e0da41 is the “Connection ID”. Please save it, you will need it in a future step.

Step 4 - Set up the webhook on Jira side

This differs for Cloud customers and Data Center customers. Please follow the appropriate instructions for each:

Cloud

Go to you Jira Service Management main page.

Click on Projects > View all projects.

Select any project from the list.

Click on Project Settings > Automation > Global administration.

Click on Create Rule.

Choose Issue Created as New trigger, use search if needed

Click on Save

Choose on New Action as Add Component

Choose Send web request as New Action, use search if neede

Enter https://CLIENT_SUBDOMAIN.ymeadows.com/api/v1/webhooks/jira/CONNECTION_ID as Web request URL where CONNECTION_ID is ID of the connection from Step 3 and CLIENT_SUBDOMAIN is the subdomain of your Y Meadows install.

Under Headers section:

• Enter X-YM-Secret as Name.

• Enter Webhook Secret from Step 3 as Value.

Choose POST as HTTP Method

Choose Issue data as Web request body

Click on Save

Enter YM Automation as Automation Name

Click Turn it on

Data Center

1. Click the Gear icon on the top right corner to open a drop down menu

2. Click System in the drop down menu

3. You may need to login again to enter admin mode

4. There is a navigation menu in the left panel, under Advanced towards the bottom, click on WebHooks

5. Click + Create a WebHook towards the top right of the page to create a new one.

These are the settings:

Name: Y Meadows Listener Status: Enabled URL: https://<CLIENT SUBDOMAIN>.ymeadows.com/api/v1/webhooks/jira/<CONNECTION ID>

Replace <CLIENT SUBDOMAIN> with your Y Meadows installs subdomain, i.e. the portion of your Y Meadows URL that comes between https:// and .ymeadows.com. Replace <CONNECTION ID> with the value you saved in Step 3.

Events: Click the check box next to created under the Issue list

Click Create