> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cymph.io/llms.txt
> Use this file to discover all available pages before exploring further.

# JIRA

> Push playbook steps into JIRA as issues.

## What Cymph uses it for

Cymph connects to JIRA to read project and issue metadata, and to create issues from playbook content. This connector performs both **read** and **write** operations.

<Note>
  JIRA and [Confluence](/integrations/content/confluence) are separate integration types but share the same Atlassian API token mechanism. The token must be created for the right app and carry the scopes listed below.
</Note>

## Requirements

| Field              | Description                                                         |
| ------------------ | ------------------------------------------------------------------- |
| **Instance URL**   | The URL of your instance, e.g. `https://mydomain.atlassian.net`     |
| **E-mail address** | The e-mail address of the Atlassian user, e.g. `myuser@example.com` |
| **API token**      | An API token for your JIRA account (see below)                      |

## Token setup

Follow the instructions provided [here](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/) to generate a token. The token must be created for the **JIRA** app and have the appropriate scopes for reading and creating issues.

## Permissions

The following scopes are required:

```
read:project:jira
read:issue-type:jira
read:field:jira
write:issue:jira
```

Or, if you are using classic scopes:

```
read:jira-work
write:jira-work
```

An Atlassian API token inherits the permissions of the user it belongs to, so the account must have access to the projects you want Cymph to write into.

<Tip>
  Use a dedicated Atlassian service account rather than a personal one — issues created by Cymph will be attributed to whichever account owns the token.
</Tip>

## What Cymph reads and writes

Cymph reads projects, issue types, and field definitions so it can build a valid issue payload, then creates issues.

**Cymph never deletes issues.** Nothing already in your JIRA project is removed by the integration.

## Testing the connection