SignalFx Developers Guide

Integrating with Jira

Jira integration using the API supports both Jira Cloud and Jira Server. These integrations differ only in their request and response bodies.

Considerations for Jira integrations

You can set the following optional property for a Jira integration:

Assignee

User name that Jira sets when it creates a ticket for a new notification. You can specify the Jira short username and optionally the Jira display name. If a detector also sets assignee, that value overrides the integration value. If neither value is set, Jira uses the default assignee for the specified project.

Create integration

Use the operation POST https://api.{REALM}.signalfx.com/v2/integration.

The SignalFx API token you use for this operation must be associated with a user who has administrative access. To learn more, see the topic Authentication Tokens.

Create a Jira Cloud integration

To create a Jira Cloud integration, you need to authenticate with your Jira Cloud instance using the following credentials:

  • Jira Cloud user email for a user who has project permissions to browse projects, create issues, and add comments

  • Jira API token

At a minimum, you must specify the following required properties in the request body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "name": "<INTEGRATION_NAME>",
    "type": "Jira",
    "enabled": true,
    "apiToken": "<JIRA_API_TOKEN>",
    "authMethod": "EmailAndToken"
    "baseUrl" : "<JIRA_INSTANCE_BASEURL>",
    "issueType": "<JIRA_ISSUE_TYPE>"
    "projectKey" : "<JIRA_PROJECT_KEY>",
    "userEmail" : "<JIRA_USER_EMAIL>",
}
  • "<INTEGRATION_NAME>": Label for this integration. By default, name is set to "Jira", so you can provide another value to differentiate between integrations to different Jira instances. To learn more about integration naming, see the note About naming your integrations in the product documentation.

  • "<JIRA_API_TOKEN>": Token for the Jira user associated with userEmail

  • "<JIRA_INSTANCE_BASEURL>": Base URL for your Jira Cloud instance. Refer to your Jira settings to find the URL.

  • "<JIRA_ISSUE_TYPE>": Specifies the Jira Type value of the issue created when a detector fires. SignalFx validates this property against existing types for the project associated with projectKey.

  • "<JIRA_PROJECT_KEY>": Specifies the Jira Project value of the issue created when a detector fires

  • "<JIRA_USER_EMAIL>": Jira user email

To learn more about the request body properties, see the Create Integration REST API reference topic.

Create a Jira Server integration

To create a Jira Server integration, you need to authenticate with your Jira server using the following credentials:

  • User name for a user who has project permissions to browse projects, create issues, and add comments

  • Password for the user name

At a minimum, you must specify the following required properties in the request body:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "name": "<INTEGRATION_NAME>",
    "type": "Jira",
    "enabled": true,
    "authMethod": "UsernameAndPassword"
    "baseUrl" : "<JIRA_SERVER_BASEURL>",
    "issueType": "<JIRA_ISSUE_TYPE>"
    "password": "<JIRA_USER_PASSWORD>",
    "projectKey" : "<JIRA_PROJECT_KEY>",
    "userName" : "<JIRA_USER_NAME>",
}
  • "<INTEGRATION_NAME>": Label for this integration. By default, name is set to "Jira", so you can provide another value to differentiate between integrations to different Jira instances. To learn more about integration naming, see the note About naming your integrations in the product documentation.

  • "<JIRA_INSTANCE_BASEURL>": Base URL for your Jira Cloud instance. Refer to your Jira settings to find the URL.

  • "<JIRA_ISSUE_TYPE>": Specifies the Jira Type value of the issue created when a detector fires. SignalFx validates this property against existing types for the project associated with projectKey.

  • "<JIRA_PROJECT_KEY>": Specifies the Jira Project value of the issue created when a detector fires

  • "<JIRA_USER_PASSWORD>": Password for the specified Jira user

  • "<JIRA_USER_NAME>": Jira user name

To learn more about the request body properties, see the Create Integration REST API reference topic.

© Copyright 2019 SignalFx.

Third-party license information