Integrations

Manage third-party integrations such as Jira.

Create Jira issue from a run test

post

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}/jira/issues

Creates a Jira issue using the organization Jira integration, with title and description built from the specified run and test (same linking behavior as the dashboard). Identifies the Jira site via jiraInstallationId (shown in the dashboard as Installation ID). Requires a write-scoped API key. On 404, the error field indicates whether the Currents project, Jira installation, run, or test was not found.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

Body

application/json

runIdstring · min: 1Required

Currents run ID containing the test

testIdstring · min: 1Required

Test ID within the run (client test id)

jiraInstallationIdstring · min: 1Required

Atlassian Jira installation ID for the org integration (same as Installation ID in the dashboard)

jiraProjectIdstring · min: 1Required

Jira project ID in which to create the issue

jiraIssueTypestring · min: 1Required

Jira issue type ID

Responses

201

Jira issue created and linked to the test

application/json

400

Invalid request parameters

application/json

401

Authentication failed

application/json

403

Insufficient permissions

application/json

404

Resource not found

application/json

409

Request could not be completed due to a conflict

application/json

429

Rate limit exceeded

application/json

500

Unexpected server error

application/json

post

/projects/{projectId}/jira/issues

HTTPcURLJavaScriptPython

POST /v1/projects/{projectId}/jira/issues HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "runId": "text",
  "testId": "text",
  "jiraInstallationId": "text",
  "jiraProjectId": "text",
  "jiraIssueType": "text",
  "customFields": [
    {
      "fieldId": "text",
      "value": "text"
    }
  ]
}

{
  "status": "OK",
  "data": {
    "jiraIssueKey": "text",
    "currentsIssueId": "text",
    "jiraIssueUrl": "text",
    "currentsIssueUrl": "text"
  }
}

Link existing Jira issue to a run test

post

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/projects/{projectId}/jira/issues/{jiraIssueKey}/link

Creates a link between an existing Jira issue (identified by jiraIssueKey in the path, e.g. PROJ-123) and the specified run and test. Same behavior as the dashboard link flow: resolves the test entity, builds the Currents issue title and Jira comment from the test (optionally prefixed with your comment), posts the comment on the Jira issue, and attaches the Jira ticket to the Currents issue. Identifies the Jira site via jiraInstallationId (Installation ID in the dashboard). jiraIssueType is stored on the ticket metadata (use the same value as when creating issues via the REST API, typically the issue type ID from issue type discovery). Requires a write-scoped API key. On 404, the error field indicates whether the Currents project, Jira installation, run, or test was not found.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

projectIdstringRequired

The project ID

Example: proj_abc123

jiraIssueKeystring · min: 1 · max: 255Required

Jira issue key to link (e.g. PROJ-123), as shown in Jira. Must be 1–255 characters after trimming. If missing, empty, or longer than 255 characters, the server responds with HTTP 400 and an ErrorResponse.

Body

application/json

runIdstring · min: 1Required

Currents run ID containing the test

testIdstring · min: 1Required

Test ID within the run (client test id)

jiraInstallationIdstring · min: 1Required

Atlassian Jira installation ID for the org integration (same as Installation ID in the dashboard)

jiraProjectIdstring · min: 1Required

Jira project ID for the linked issue

jiraIssueTypestring · min: 1Required

Jira issue type identifier stored on the Currents ticket (same as jiraIssueType when creating issues; use issue type discovery when unsure)

commentstringOptional

Optional text prepended to the Jira comment and Currents issue description before the automated test context (when includeContextInComment is true)

includeContextInCommentbooleanOptional

When true (default), appends the same automated test context used when creating Jira issues from a run test. When false, comment must be non-empty and is used alone for the Jira comment and issue description.

Default: true

Responses

200

Jira issue linked to the test

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

403

Insufficient permissions

application/json

404

Resource not found

application/json

409

Request could not be completed due to a conflict

application/json

429

Rate limit exceeded

application/json

500

Unexpected server error

application/json

post

/projects/{projectId}/jira/issues/{jiraIssueKey}/link

HTTPcURLJavaScriptPython

POST /v1/projects/{projectId}/jira/issues/{jiraIssueKey}/link HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "runId": "text",
  "testId": "text",
  "jiraInstallationId": "text",
  "jiraProjectId": "text",
  "jiraIssueType": "text",
  "comment": "text",
  "includeContextInComment": true
}

{
  "status": "OK",
  "data": {
    "jiraIssueKey": "text",
    "currentsIssueId": "text",
    "jiraIssueUrl": "text",
    "currentsIssueUrl": "text"
  }
}

List Jira projects

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/integrations/jira/projects

Lists Jira projects available for the organization Jira integration (via Atlassian project search). Use returned project IDs as jiraProjectId when creating or linking Jira issues.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Query parameters

jira_installation_idstring · min: 1Required

Atlassian Jira installation ID for the org integration (same as Installation ID in the dashboard)

Example: abc-123-atlassian-installation

searchstringOptional

Case-insensitive search filter for Jira metadata

Example: bug

pageintegerOptional

Page number (0-indexed)

Default: 0

limitinteger · min: 1 · max: 100Optional

Page size for Jira discovery list endpoints (default 50, max 100)

Default: 50

Responses

200

Jira projects returned successfully

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

409

Request could not be completed due to a conflict

application/json

429

Rate limit exceeded

application/json

500

Unexpected server error

application/json

get

/integrations/jira/projects

HTTPcURLJavaScriptPython

GET /v1/integrations/jira/projects?jira_installation_id=text HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "list": [
      {
        "id": "10000",
        "key": "ENG",
        "name": "Engineering",
        "description": "text",
        "avatarUrl": "text"
      }
    ],
    "count": 1,
    "total": 1,
    "nextPage": 1
  }
}

List Jira issue types

get

https://api.currents.dev/v1https://api-staging.currents.dev/v1http://localhost:4000/v1

/integrations/jira/projects/{jiraProjectId}/issue-types

Lists Jira issue types available for a Jira project and embeds custom fields required to create issues through the REST API.

Authorizations

BearerAuth

AuthorizationstringRequired

API key authentication using Bearer token

Path parameters

jiraProjectIdstring · min: 1 · max: 128Required

Jira project ID (from project search or Jira). Must be 1–128 characters. If missing, empty, or longer than 128 characters, the server responds with HTTP 400 and an ErrorResponse (status: FAILED, error describing the validation failure).

Example: 10000

Query parameters

jira_installation_idstring · min: 1Required

Atlassian Jira installation ID for the org integration (same as Installation ID in the dashboard)

Example: abc-123-atlassian-installation

searchstringOptional

Case-insensitive search filter for Jira metadata

Example: bug

pageintegerOptional

Page number (0-indexed)

Default: 0

limitinteger · min: 1 · max: 100Optional

Page size for Jira discovery list endpoints (default 50, max 100)

Default: 50

Responses

200

Jira issue types returned successfully

application/json

statusstring · enumRequiredPossible values:

400

Invalid request parameters

application/json

401

Authentication failed

application/json

404

Resource not found

application/json

409

Request could not be completed due to a conflict

application/json

429

Rate limit exceeded

application/json

500

Unexpected server error

application/json

get

/integrations/jira/projects/{jiraProjectId}/issue-types

HTTPcURLJavaScriptPython

GET /v1/integrations/jira/projects/{jiraProjectId}/issue-types?jira_installation_id=text HTTP/1.1
Host: api.currents.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "OK",
  "data": {
    "list": [
      {
        "id": "10001",
        "name": "Bug",
        "description": "text",
        "iconUrl": "text",
        "projectId": "text",
        "customFields": [
          {
            "fieldId": "customfield_10010",
            "key": "customfield_10010",
            "name": "Severity",
            "required": true,
            "fieldType": "TEXT",
            "allowedValues": [
              {
                "id": "text",
                "name": "text"
              }
            ],
            "originalType": "text"
          }
        ]
      }
    ],
    "count": 1,
    "total": 1,
    "nextPage": 1
  }
}