Skip to content

Jira Sensor

What it ingests

Issue activity from Jira Cloud — issues and their changelog — optionally scoped to specific projects or narrowed with an extra JQL filter. Jira Server / Data Center is not yet supported.

Credential

References a jira_api_token credential by id. The secret is an Atlassian Cloud API token. Together with the account email and site URL (both on the sensor config below) it forms the Basic-auth pair the sensor sends on every REST call.

bash
curl -sS -X POST https://your-corveil-host/api/credentials \
  -H "Authorization: Bearer <admin>" -H "Content-Type: application/json" \
  -d '{"type":"jira_api_token","name":"acme-jira-token","secret":"ATATT..."}'

Config fields

KeyRequiredNotes
site_urlyesYour Jira Cloud site URL, e.g. https://acme.atlassian.net.
emailyesEmail of the Atlassian account that owns the API token.
project_keysnoComma-separated project keys, e.g. ENG, OPS. Blank ingests every project the token can read.
jql_filternoOptional JQL clauses ANDed into every poll, e.g. labels = engineering. Interpolated verbatim into queries scoped to this sensor's own token/site; a malformed fragment surfaces as a Jira 400.

Provider-side setup

  1. Sign in as the Atlassian account that should own the token.
  2. Create an API token at id.atlassian.com/manage/api-tokens.
  3. Make sure that account can view the projects you want to ingest.

Wire-up

POST /api/sensors

json
{
  "sensor_type": "jira",
  "name": "Acme Jira",
  "config": {
    "site_url": "https://acme.atlassian.net",
    "email": "integrations@acme.com",
    "project_keys": "ENG, OPS"
  },
  "credentials": { "api_token": "<jira_api_token credential id>" }
}

Verify

Run Test connection to confirm the site URL, email, and token authenticate. Once polling, created and updated issues in the selected projects appear as task events.