Document toolboxDocument toolbox

Jira delivery methods

[ 1 Details ] [ 2 Activation ] [ 3 Usage ]

Details

This delivery method creates a new issue of a specific type in a Jira project. Create a delivery method for each combination of project key and issue type needed to accommodate the alerts that will trigger Jira issues. For example, you might have one delivery method that creates a Bug-type issue in the SEC project key and another that creates a Task type issue in the NET project key.

You can find below the information required on the New Delivery Method window for this delivery method (for the creation process visit Manage delivery methods).

Name

A unique name that identifies this delivery method. 

URL

The URL of the Jira Cloud site to which alerts will be sent, which follows the format https://<your_JIRA_domain>.atlassian.net/rest/api/2/issue/. Be aware that the number 2 corresponds to the Jira API version supported, which is the only supported version currently (prior or later versions are unsupported).

Jira server on a private network

Note that if your Jira server is inside a private network you will not receive alerts on your server.

User and Password

This is the JIRA server username and password for communication with the server. The username should be the email address associated with the Atlassian account and the Password should be the API token as configured here.

Issue type

Specify the Jira issue type for alerts that use this delivery method (Task, Bug, Story...). Be aware that the issue type must be written exactly as it exists in Jira, otherwise you will get an error message.

Issue type in Jira

Please note that your Issue Type in Jira must not have Required/Mandatory fields other than Summary (where the name of the Devo Alert will populate), otherwise, you will not be able to create the delivery method.

Project key

Specify the project key under which the alert will be created. The project key is the prefix used for numbering issues in a specific project. Be aware that the project key must be written exactly as it exists in Jira, otherwise you will get an error message.

Time zone

This is the time zone that will be used to calculate when alerts can be sent. This will be applied to the schedule defined in any sending policy that uses this delivery method.

Language

The language in which to send the alert content.

Activation

The new delivery method is saved in Pending status.

To activate it, you will need to introduce in Devo the Jira validation code you will receive. This Jira validation code will be displayed on the Jira server, in a new JIRA issue of the type specified in the form, which was created by this process with the title "Activation Code".

Copy the code and then return to the newly created delivery method in Devo.

Click pending activation under the status column, paste the validation code into the Activation Code window and click Apply.

You can now associate this new delivery method with sending policies to start receiving alerts through this method.

Usage

When creating an alert that will use this delivery method, you must include a description in the alert creation window, otherwise you will get an error when the alert is triggered (see Creating new alerts for more info about the alert creation window).

 

Related articles: