jira

Available in: Cloud, Self-Managed

Queries Jira resources and returns structured data.

  • Common

  • Advanced

processors:
  label: ""
  jira:
    base_url: "" # No default (required)
    username: "" # No default (required)
    api_token: "" # No default (required)
    max_results_per_page: 50
    request_timeout: 30s
    max_retries: 10
processors:
  label: ""
  jira:
    base_url: "" # No default (required)
    username: "" # No default (required)
    api_token: "" # No default (required)
    max_results_per_page: 50
    request_timeout: 30s
    max_retries: 10

Executes Jira API queries based on input messages and returns structured results. The processor handles pagination, retries, and field expansion automatically.

Supports querying the following Jira resources:

  • Issues (JQL queries)

  • Issue transitions

  • Users

  • Roles

  • Project versions

  • Project categories

  • Project types

  • Projects

The processor authenticates using basic authentication with username and API token. Input messages should contain valid Jira queries in JSON format.

Fields

api_token

The Jira API token for the specified account. You can generate an API token from your Atlassian account settings.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration.

Type: string

base_url

The base URL of the Jira instance (for example, https://your-domain.atlassian.net).

Type: string

max_results_per_page

The maximum number of results to return per page when calling the Jira API. Pagination in the Jira API is zero-based, so the first page starts at 0.

Type: int

Default: 50

max_retries

The maximum number of retries to attempt when a 429 HTTP status code is received. Jira APIs may return a 429 status code when the rate limit is exceeded.

Type: int

Default: 10

request_timeout

The maximum duration to wait for a response from the Jira API before timing out.

Type: string

Default: 30s

username

The username or email address of the Jira account.

Type: string

Examples

Minimal configuration

Basic Jira processor setup with required fields only

pipeline:
  processors:
    - jira:
        base_url: "https://your-domain.atlassian.net"
        username: "${JIRA_USERNAME}"
        api_token: "${JIRA_API_TOKEN}"

Full configuration with tuning

Complete configuration with pagination, timeout, and retry settings

pipeline:
  processors:
    - jira:
        base_url: "https://your-domain.atlassian.net"
        username: "${JIRA_USERNAME}"
        api_token: "${JIRA_API_TOKEN}"
        max_results_per_page: 200
        request_timeout: "30s"
        max_retries: 50