Skip to main content

Jira alert

Reading time: 0 minute(s) (0 words)

The Jira alert method automatically opens a Jira issue to notify you whenever an incident is triggered.

Authentication​

Setting up the Jira integration requires an API token. You can obtain this by logging into your Jira account and clicking on your profile. See the Atlassian account documentation for more details.

Configuring the Jira alert method​

You can configure your Jira alert method directly in the Nobl9 UI, or by applying a YAML file in sloctl.

For this alert method to function correctly, the following prerequisites must be met:

  • The user must have access and permission to create an issue in a project. Otherwise, the Nobl9 backend will receive an error from the Jira API, and the ticket will not be created.

  • All fields designated as mandatory by Nobl9 project settings must be included in the Nobl9 Jira message, or ticket creation will fail. For example, you may need to include values for the Due date or Fix versions fields.

  • By default, the Nobl9 Jira message contains the following fields:

    • Summary

    • Description

    • Issue Type (always set to Bug)

Caution: In order for a Jira alert to be sent, all the above-mentioned fields need to exist in your Jira project.

Nobl9 UI​

  1. Navigate to Integrations > Alert Methods.
  2. Click .
  3. Click the relevant Alert Method icon.

Then, in the Jira Configuration Wizard:

  1. Enter the URL.
    The URL must start with https://.

  2. Enter a Username.
    Typically, the username is the email address of the person that owns the API token.

  3. Enter an API Token.
    For more information, refer to the Authentication section.

  4. Enter a Jira Project Key.
    The code of the project, for example: PC, AT, PM.

  1. Select a Project.
    Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses the default project.
  2. Enter a Display Name.
    You can enter a user-friendly name with spaces in this field.
  3. Enter a Name.
    The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example, my-alert-method-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result.
  4. Enter a Description.
    Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
  5. Click Add Alert Method.

YAML configuration for Jira alerts​

General YAML sample for Jira alert method
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: string # Mandatory
  displayName: string # Optional
spec:
  jira:
    url: string # Mandatory, must start with https://
    username: string # Mandatory
    apiToken: string # Mandatory, secret
    projectKey: string # Mandatory

Here’s a description of fields:

  • url is the Jira instance URL. The https:// prefix is required.

  • username is the email address of your API token owner.

  • apiToken is your API token, which you create by logging into your Jira account and clicking on your profile.

    note

    The apiToken is kept secret and is not returned with the get command in sloctl. When you create the alert method, the apiToken field is required; it’s optional when you’re updating the alert method. The updated alert method uses the behavior from the existing object.

  • projectKey is the code of the Jira project: AT (alert test), PM (project management), etc.

Testing the Jira alert method in the UI​

You can test alert methods for all notification services supported by the Nobl9 platform through the UI.

To verify the correctness of your alert method configuration:

  1. Navigate to Integrations > Alert Methods.
  2. Click the required alert method.
    Its Details page opens.
  3. Click Test under the alert method name:
    • For the correct configuration, Nobl9 displays Test completed successfully! under the button
    • Otherwise, Nobl9 displays the Test failed message, specifying what is set incorrectly
For a more in-depth look, consult additional resources:
Jira alert methodTerraform provider
Last updated on
On this page