If you’re new to Unstructured, read this note first.

Before you can create a source connector, you must first sign up for Unstructured and get your Unstructured API key. After you sign up, the Unstructured user interface (UI) appears, which you use to get the key. To learn how, watch this 40-second how-to video.

After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create source connectors with the Unstructured user interface (UI). Learn how.

If you need help, reach out to the community on Slack, or contact us directly.

You are now ready to start creating a source connector! Keep reading to learn how.

Ingest your files into Unstructured from Jira.

The requirements are as follows.

  • 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 and including /jira, such as https://<organization>.atlassian.net/jira.

  • 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:

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

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import (
    CreateSourceConnector,
    SourceConnectorType,
    JiraSourceConnectorConfigInput
)

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=SourceConnectorType.JIRA,
                config=JiraSourceConnectorConfigInput(
                    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>"
                    ]
                )
            )
        )
    )

    print(response.source_connector_information)

Replace the preceding placeholders as follows:

  • <name> (required): A unique name for this connector.
  • <url> (required): The URL of the Jira instance.
  • <username> (required for password or API token authentication, or personal access token authentication): The username of the Jira user.
  • <password> (required for password or API token authentication): The password or API token of the Jira user.
  • <token> (required for personal access token authentication): The personal access token of the Jira user.
  • <project-id>: The ID of a target project in Jira to access.
  • <board-id>: The ID of a target board in Jira to access.
  • <issue-id>: The ID of a target issue in Jira to access.

Was this page helpful?

Suggest edits