Jira

First time creating a connector? Read this first.

Ingest your files into Unstructured from Jira.

Requirements

You will need:

• A Jira Cloud account or Jira Data Center installation.

• The site URL for your Jira Data Center installation or Jira Cloud account. For Jira Cloud, open Jira in your web browser and copy the address from the browser’s address bar. If you’re unsure, check the dashboard URL, or if viewing an issue, project or board, the site URL is typically everything that comes before but not including /jira, such as https://<organization>.atlassian.net.

• To process Jira projects, provide the IDs for the target projects. To get a project’s ID, sign in to your Jira Cloud account or Jira Data Center installation, and then go to the following URL: https://<organization>.atlassian.net/rest/api/latest/project/<project-key>, replacing <organization> with yours, and replacing <project-key> with the target project’s key. In the response, look for the URL https://<organization>.atlassian.net/rest/api/3/project/<project-id>, where <project-id> is the target project’s ID.

• To process Jira boards, the IDs for the target boards. To get a board’s ID, sign in to your Jira Cloud account or Jira Data Center installation, and then go to the following URL: https://<organization>.atlassian.net/rest/agile/1.0/board?projectKeyOrId=<project-key-or-id>, replacing <organization> with yours, and <project-key-or-id> with the associated project’s key or ID. In the response, look for the URL https://<organization>.atlassian.net/rest/agile/1.0/board/<board-id>, where <board-id> is the board’s ID.

• To process Jira issues, the IDs for the target issues. To get an issue’s ID, sign in to your Jia Cloud account or Jira Data Center installation, open the issue, and then look at the URL in your browser’s address bar. The issue ID is the string of characters after the final slash in the URL.

• A user in your Jira Cloud account or Jira Data Center installation.

• The user must have the correct permissions in your Jira Cloud account or Jira Data Center installation to access the target projects, boards, and issues.

• One of the following:

  • For Jira Cloud or Jira Data Center, the target user’s name or email address, and password. Change a Jira Cloud user’s password. Change a Jira Data Center user’s password.
  • For Jira Cloud only, the target user’s name or email address, and API token. Create an API token.
  • For Jira Data Center only, the target user’s personal access token (PAT). Create a PAT.

Examples

To create a Jira source connector, see the following examples.

For more information on working with source connectors using the Unstructured API, see Source endpoints.

Python SDK

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type="jira",
                config={
                    "url": "<url>",

                    # For password or API token authentication:
                    # "username": "<username>",
                    # "password": "<password>",

                    # For personal access token authentication:
                    # "token": "<token>",

                    "projects": [
                        "<project-id>",
                        "<project-id>"
                    ],
                    "boards": [
                        "<board-id>",
                        "<board-id>"
                    ],
                    "issues": [
                        "<issue-id>",
                        "<issue-id>"
                    ],
                    "status_filters": [
                        "<status>",
                        "<status>"
                    ],
                    "download_attachments": <True|False>,
                    "cloud": <True|False>
                }
            )
        )
    )

    print(response.source_connector_information)

curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/sources" \
--header 'accept: application/json' \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'content-type: application/json' \
--data \
'{
    "name": "<name>",
    "type": "jira",
    "config": {
        "url": "<url>",

        # For password or API token authentication:
        "username": "<username>",
        "password": "<password">,

        # For personal access token authentication:
        "token": "<token>",
        
        "projects": [ 
            "<project-id>",
            "<project-id>"
        ],
        "boards": [ 
            "<board-id>",
            "<board-id>"
        ],
        "issues": [ 
            "<issue-id>",
            "<issue-id>"
        ],
        "status_filters": [
            "<status>",
            "<status>"
        ],
        "download_attachments": <true|false>,
        "cloud": <true|false>
    }
}'

Configuration settings

Replace the preceding placeholders as follows:

name · string · required

A unique name for this connector.

url · string · required

The URL of the Jira instance.

username · string

Required for password or API token authentication. The username of the Jira user.

password · string

Required for password or API token authentication. For password authentication, the password of the Jira user. For API token authentication, the API token of the Jira user.

token · string

Required for personal access token authentication. The personal access token of the Jira user.

projects · string

The ID of a target project in Jira to access.

boards · string

The ID of a target board in Jira to access.

issues · string

The ID of a target issue in Jira to access.

status_filters · string

The name of a status to filter Jira issues by.

download_attachments · boolean · default: "false"

Set to true to download attachments from Jira issues.

cloud · boolean

Set to true to specify using Jira Cloud or false to specify using Jira Data Center. The default is to use Jira Data Center.

oauth_token · string

Provides authentication for Unstructured Foundation. Unstructured Foundation enables you to processes your files once, maintain a persistent enrichment index, and gives every AI tool your team uses persistent access to your organization’s knowledge without file uploads.

Not supported for the Unstructured Pipeline API.

refresh_token · string

Provides authentication for Unstructured Foundation. Unstructured Foundation enables you to processes your files once, maintain a persistent enrichment index, and gives every AI tool your team uses persistent access to your organization’s knowledge without file uploads.

Not supported for the Unstructured Pipeline API.

Learn more

•   Jira Integration in Unstructured: Build RAG Systems with Project Management Data