Documentation Index
Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
π Quickstart
Connect to Jira with Nango and see data flow in 2 minutes.
Authorize Jira
Go to Connections -> Add Test Connection -> Authorize, then log in to Jira. Later, youβll let your users do the same directly from your app. Call the Jira API
Letβs make your first request to the Jira API (fetch a list of issues). Replace the placeholders below with your secret key, integration ID, and connection ID:curl "https://api.nango.dev/proxy/ex/jira/{connectionConfig.cloudId}/rest/api/3/search?maxResults=10" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>"
Install Nangoβs backend SDK with npm i @nangohq/node. Then run:import { Nango } from '@nangohq/node';
const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
const res = await nango.get({
endpoint: '/ex/jira/{connectionConfig.cloudId}/rest/api/3/search',
params: {
maxResults: 10
},
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});
console.log(JSON.stringify(res.data, null, 2));
Or fetch credentials with the Node SDK or API.The {connectionConfig.cloudId} in the URL represents the cloudId. You can get this value from your connection configuration after creating the connection. The cloudId is automatically set by Nango.
β
Youβre connected! Check the Logs tab in Nango to inspect requests. Implement Nango in your app
Follow our Auth implementation guide to integrate Nango in your app.To obtain your own production credentials, follow the setup guide linked below.
π Jira Integration Guides
Nango maintained guides for common use cases.
Official docs: Jira REST API v3 Documentation
π§© Pre-built syncs & actions for Jira
Enable them in your dashboard. Extend and customize to fit your needs.
Attachments
| Function name | Description | Type | Source code |
|---|
delete-attachment | Delete an attachment from a Jira issue | Action | π Github |
| Function name | Description | Type | Source code |
|---|
delete-comment | Delete a comment from a Jira issue | Action | π Github |
update-comment | Update a comment on a Jira issue | Action | π Github |
| Function name | Description | Type | Source code |
|---|
list-fields | List Jira field metadata available to the user. | Action | π Github |
Issue Types
| Function name | Description | Type | Source code |
|---|
list-issue-types | List Jira issue types available to the user | Action | π Github |
Issue Worklogs
| Function name | Description | Type | Source code |
|---|
update-worklog | Update a worklog on a Jira issue. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
add-attachment | Attach a file to a Jira issue | Action | π Github |
add-comment | Add a comment to a Jira issue. | Action | π Github |
add-watcher | Add a watcher to a Jira issue | Action | π Github |
create-issue-link | Link two Jira issues with a relationship type | Action | π Github |
create-issue | Create a Jira issue in a project. | Action | π Github |
delete-issue-link | Delete a link between Jira issues | Action | π Github |
delete-issue | Delete a Jira issue by ID or key | Action | π Github |
get-create-issue-metadata | Retrieve project and issue type metadata for issue creation. | Action | π Github |
get-edit-issue-metadata | Retrieve editable field metadata for an existing Jira issue | Action | π Github |
get-issue-changelog | Retrieve the changelog for a Jira issue | Action | π Github |
get-issue | Retrieve a Jira issue by ID or key | Action | π Github |
list-issue-comments | List comments on a Jira issue with pagination | Action | π Github |
list-transitions | List available workflow transitions for a Jira issue | Action | π Github |
list-watchers | List watchers on a Jira issue | Action | π Github |
search-issues | Search Jira issues using JQL. | Action | π Github |
transition-issue | Move a Jira issue through a workflow transition. | Action | π Github |
update-issue | Update issue fields on an existing Jira issue | Action | π Github |
Priorities
| Function name | Description | Type | Source code |
|---|
get-priority | Retrieve a Jira priority by priority ID. | Action | π Github |
list-priorities | List Jira priorities available to the user. | Action | π Github |
Projects
| Function name | Description | Type | Source code |
|---|
get-project | Retrieve a Jira project by ID or key. | Action | π Github |
list-project-components | List components for a Jira project | Action | π Github |
list-project-versions | List versions for a Jira project | Action | π Github |
list-projects | List Jira projects accessible to the authenticated user. | Action | π Github |
Statuses
| Function name | Description | Type | Source code |
|---|
get-status | Retrieve a Jira status by status ID or name. | Action | π Github |
list-statuses | List Jira statuses available to the user | Action | π Github |
| Function name | Description | Type | Source code |
|---|
get-myself | Retrieve the currently authenticated Jira user. | Action | π Github |
get-user | Retrieve a Jira user by account ID | Action | π Github |
list-users | Search Jira users visible to the authenticated account. | Action | π Github |
Watchers
| Function name | Description | Type | Source code |
|---|
remove-watcher | Remove a watcher from a Jira issue | Action | π Github |
Worklogs
| Function name | Description | Type | Source code |
|---|
add-worklog | Log time against a Jira issue. | Action | π Github |
delete-worklog | Delete a worklog from a Jira issue. | Action | π Github |
list-worklogs | List worklogs on a Jira issue | Action | π Github |
| Function name | Description | Type | Source code |
|---|
get-field | Retrieve Jira field metadata by field ID | Action | π Github |
get-issue-type | Retrieve Jira issue type metadata by issue type ID. | Action | π Github |
fields | Sync Jira field metadata available to the authenticated user. | Sync | π Github |
issue-types | Sync Jira issue types available to the authenticated user | Sync | π Github |
issues | Sync Jira issues using JQL-backed search with incremental updates | Sync | π Github |
project-components | Sync Jira project components for projects in scope | Sync | π Github |
project-versions | Sync Jira project versions for projects in scope | Sync | π Github |
projects | Sync Jira projects accessible to the authenticated user. | Sync | π Github |
users | Sync Jira users visible to the authenticated account | Sync | π Github |