Jira
Schema-driven source documentation.
JIRA38 fields2 examples
Commonly Asked Questions
Assistant knowledge mapped to this source type from
assistant_knowledge.json.Required
Fields required for a valid configuration payload under `config.required`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| required | object | Yes | — | — | no extra properties |
| required.account_email | string | Yes | Atlassian account email used with API token for Basic authentication | — | format email |
| required.base_url | string | Yes | Jira Cloud tenant URL (for example, https://your-domain.atlassian.net) | — | format uri |
Masked
Sensitive fields under `config.masked` (secrets/credentials).
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| masked | object | Yes | — | — | no extra properties |
| masked.api_token | string | Yes | Atlassian API token for Jira Cloud | — | — |
Optional
Optional configuration fields under `config.optional`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| optional | object | No | — | — | no extra properties |
| optional.connection | object | No | HTTP and retry settings for Jira API calls. | — | no extra properties |
| optional.connection.max_retries | integer | No | Maximum retry attempts for transient API failures and rate limits | 3 | min 0, max 10 |
| optional.connection.rate_limit_delay_seconds | number | No | Additional delay between API requests to reduce rate-limit pressure | 0 | min 0 |
| optional.connection.request_timeout_seconds | number | No | HTTP request timeout for Jira API calls | 30 | min 1 |
| optional.content | object | No | Jira issue content extraction controls. | — | no extra properties |
| optional.content.attachment_max_bytes | integer | No | Maximum bytes downloaded per attachment for MIME inference and text extraction | 5242880 | min 1024 |
| optional.content.include_attachments | boolean | No | Include issue attachments as related assets | true | — |
| optional.content.include_comments | boolean | No | Include issue comments and aggregate them into a per-issue comments asset | true | — |
| optional.scope | object | No | Optional Jira scope filters. When omitted, all visible issues are eligible for sampling. | — | no extra properties |
| optional.scope.jql | string | No | Additional JQL filter to combine with project scope | — | min length 1 |
| optional.scope.project_ids | array | No | Project IDs to include (up to 50) | — | min items 1, max items 50 |
| optional.scope.project_ids[] | integer | No | — | — | — |
| optional.scope.project_keys | array | No | Project keys to include (up to 50) | — | min items 1, max items 50 |
| optional.scope.project_keys[] | string | No | — | — | — |
Examples
Reference payloads generated from shared source examples JSON.
Jira project issues with project scope
Ingest Jira issues for selected projects with comments and attachments enabled
Schedule
{
"enabled": true,
"preset": "weekday_business",
"cron": "15 10 * * 1-5",
"timezone": "UTC"
}Config Payload
{
"type": "JIRA",
"required": {
"base_url": "https://acme.atlassian.net",
"account_email": "[email protected]"
},
"masked": {
"api_token": "your-atlassian-api-token"
},
"optional": {
"connection": {
"request_timeout_seconds": 30,
"max_retries": 3
},
"scope": {
"project_keys": [
"PLAT",
"SEC"
]
},
"content": {
"include_comments": true,
"include_attachments": true,
"attachment_max_bytes": 5242880
}
},
"sampling": {
"strategy": "LATEST",
"limit": 150
}
}Jira tenant-wide latest issue scan
Scan all visible Jira issues and rely on sampling to limit each run
Schedule
{
"enabled": true,
"preset": "daily",
"cron": "40 7 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "JIRA",
"required": {
"base_url": "https://acme.atlassian.net",
"account_email": "[email protected]"
},
"masked": {
"api_token": "your-atlassian-api-token"
},
"optional": {
"content": {
"include_comments": true,
"include_attachments": false
}
},
"sampling": {
"strategy": "RANDOM",
"limit": 50
}
}