Jira for Ticketing
Jira for Ticketing is an Astralis integration that opens a Jira ticket when a privacy request is approved, tracks that ticket, and completes the request's Jira step when the ticket closes. Use it when your team already works privacy requests in Jira and you want Astralis to handle intake, deadlines, identity data, and the emails to the data subject.
Each privacy request moves through Jira for Ticketing in four stages:
- A privacy request is approved in Astralis.
- Astralis creates a Jira ticket from your template and links it to the request. The request shows Pending External while it waits.
- Your team works the ticket in Jira, using your existing projects, boards, and automation.
- When the ticket reaches its closing status, Astralis completes the Jira step and the request continues to completion.
Jira for Ticketing is different from the Jira integration, which runs access and erasure requests against data stored within Jira. Jira for Ticketing uses Jira as a task management tool for the work your team does by hand.
Check the prerequisites
- A Jira Cloud site, for example
your-domain.atlassian.net. - A Jira account that can create issues in the target project. Use a service account rather than a person's account, so the connection keeps working when people change roles.
- One of these ways to authenticate:
- API token: a Jira integration configured with a classic Atlassian API token. Jira for Ticketing links to its credentials.
- OAuth 2.0: a Jira OAuth 2.0 (3LO) app (opens in a new tab) and the OAuth settings in Configure deployment settings.
Astralis supports one Jira for Ticketing integration per deployment.
Connect Astralis to Jira
Add the integration
- Go to Integrations and select Add integration.
- Search for Jira for Ticketing, or filter by the Manual category, and select it.
- Enter a Name and an optional Description.
- Under Request types, keep the request types that should open a Jira ticket, such as Access, Erasure, and Consent. Remove the rest.
- Select Save.
Add credentials
Open the integration and select the Credentials tab. Choose one method.
| Method | How it works | Use it when |
|---|---|---|
| Link from existing connector | Astralis copies the API token from your Jira integration and keeps it in sync, so you rotate the token in one place. | You authenticate with an Atlassian API token. |
| OAuth authorization | Astralis redirects you to Atlassian to grant access. Astralis refreshes the tokens automatically, five minutes before they expire. | Your deployment has an Atlassian OAuth app configured. |
To link credentials:
- Under Link from existing connector, select your Jira integration from Select a Jira connector.
- Select Link credentials. Credential status shows Linked to the integration you chose, with a Synced tag.
Astralis accepts classic Atlassian API tokens. Create one under Security > API tokens in your Atlassian account with Create API token. Tokens created with Create API token with scopes don't work with the Jira site address.
To authorize with OAuth:
- Under OAuth authorization, select Authorize with Jira.
- On Atlassian's consent screen, choose the Jira site to use and grant access. Astralis requests
read:jira-work,write:jira-work,read:jira-user, andoffline_access. - Atlassian returns you to the integration in Astralis. Tickets are created as the user who authorized.
Configure ticket templates
Select the Ticket setup tab to set how Astralis creates tickets.
| Field | What it controls | Required |
|---|---|---|
| Project | The Jira project for new tickets. Astralis lists the projects your credentials can see. | Yes |
| Issue type | The issue type for new tickets, such as Task. Subtask types aren't offered. | Yes |
| Completion trigger | The Jira status that completes the request's Jira step. The default is any status in Jira's Done category. | No |
| Summary template | The ticket title, built from template variables. | Yes |
| Description template | The ticket body, built from template variables. | No |
| Due date (time after approval) | The ticket's Jira due date: 7, 14, 30, 45, or 60 days after approval. No due date sets the due date from the request's policy deadline instead. | No |
Select Preview ticket to see the rendered summary and description with sample values, then select Save configuration.
Example summary template:
[__REQUEST_TYPE__] __EMAIL__Example description template:
Request type: __REQUEST_TYPE__
Policy: __POLICY_NAME__
Email: __EMAIL__
Phone: __PHONE__
Submitted: __SUBMISSION_DATE__
Due: __DUE_DATE__
Open in Astralis: __FIDES_REQUEST_URL__
Use template variables
Type / or __ in a template field to open the variable picker. Astralis inserts each variable as __VARIABLE_NAME__ and replaces it with the request's value when it creates the ticket. A variable with no value renders as None Provided.
| Variable | Value |
|---|---|
__REQUEST_ID__ | The Astralis privacy request ID, for example pri_abc123-def456 |
__REQUEST_TYPE__ | The request type, such as access, erasure, or consent |
__SUBMISSION_DATE__ | When the data subject submitted the request, as a UTC timestamp |
__APPROVAL_DATE__ | When the request was approved, as a UTC timestamp |
__DUE_DATE__ | The request's policy deadline, as a UTC timestamp |
__POLICY_NAME__ | The name of the policy that governs the request |
__EMAIL__ | The data subject's email address |
__PHONE__ | The data subject's phone number |
__FIDES_REQUEST_URL__ | A link to the request in Astralis. Requires FIDES__ADMIN_UI__URL. |
__CUSTOM_<KEY>__ | The value of a custom privacy request field, for example __CUSTOM_CUSTOMER_TYPE__ for a field with the key customer_type |
Custom field variables appear in the picker when the field is defined in the Privacy Center configuration of your default property and its key uses only letters, digits, and underscores. This applies even when your request form posts to the Astralis API instead of using the Privacy Center. If Astralis can't read the configuration, the Ticket setup tab shows a warning that some template variables may be unavailable, and the picker lists only the built-in variables.
A ticket shows a custom field's value only when FIDES__EXECUTION__ALLOW_CUSTOM_PRIVACY_REQUEST_FIELD_COLLECTION was true when the request was submitted. Astralis stores custom fields only with that setting on, so without it the variable renders as None Provided on every ticket.
Preview ticket shows each custom field's label in place of a value.
Test the setup
- Select the Connection tab, then Test connection. The test checks your credentials, your ticket template, and that the project and issue type exist in Jira.
- Submit a test privacy request and approve it. Confirm that a ticket appears in your Jira project with the expected summary, description, and due date.
- Move the ticket to its closing status in Jira and confirm that the request completes in Astralis.
Track tickets on a privacy request
Each privacy request shows its tickets in the Jira tickets box of the Request details panel. The box lists each ticket's key, linked to the ticket in Jira, and its current Jira status. The Activity tab shows the Jira for Ticketing step alongside the request's other steps.
Jira for Ticketing steps don't appear in the Manual tasks tab, because your team completes them in Jira.
| Control | What it does |
|---|---|
| Refresh ticket status (refresh icon) | Checks the ticket's status in Jira now, instead of waiting for the next polling cycle. |
| Retry ticket creation (retry icon) | Creates a new ticket in Jira. Available when the linked ticket was deleted in Jira. |
| Link ticket | Links an existing Jira ticket by its key, for example PRIV-123. Use it when your team opened a ticket by hand. |
| Force close | Marks the request's pending Jira steps complete so the request can continue. The Jira tickets aren't changed, and this can't be undone. You can add a reason. |
Recover a missing or failed ticket
- Ticket creation failed: fix the cause, such as an expired token. Astralis tries again in its next polling cycle, and the ticket appears in the Jira tickets box once it's created.
- Ticket opened by hand: while Astralis couldn't reach Jira, your team may have opened a ticket themselves. Select Link ticket and enter its key, and Astralis tracks it from then on.
- Ticket deleted in Jira: select Retry ticket creation to open a new ticket, link a replacement ticket, or select Force close if the work is done.
Link ticket and Retry ticket creation are available while a request is Approved, In Processing, Paused, Pending External, or Requires Input. Force close is available until the request is Complete, Denied, or Canceled.
Understand when tickets open and close
Ticket creation
Astralis creates the ticket at approval when your deployment requires manual approval of privacy requests. When requests are approved automatically, Astralis creates the ticket in its next polling cycle. Astralis makes one attempt to create a ticket at a time, and a request still without a ticket gets another attempt in each polling cycle. When Jira rate-limits a call, Astralis waits for the interval in Jira's Retry-After header and tries up to three times. Authentication errors fail right away, and the next polling cycle tries again once the credentials work.
Status polling
Astralis checks the status of open tickets every 3 minutes by default. Change the interval with FIDES__EXECUTION__JIRA_POLLING_INTERVAL_MINUTES.
Completion
| Ticket in Jira | What Astralis does |
|---|---|
| Reaches the completion trigger status, or a Done-category status when no trigger is set | Completes the Jira step. The request continues once its other steps finish. |
| Any other status | Keeps waiting. |
| Deleted, and the step wasn't completed in Astralis | Marks the step failed. Retry ticket creation, link a replacement ticket, or force close the request. |
Closing the ticket completes the Jira step on its own. Nobody needs to submit anything in Astralis.
Note: With no completion trigger set, every status in Jira's Done category completes the request, including statuses your team may use for denied or cancelled requests. Set Completion trigger to the status that means the work is done. For a request your team decides to deny, deny it in Astralis with a reason, so the data subject receives the denial notice.
Configure deployment settings
| Setting | Default | Purpose |
|---|---|---|
FIDES__EXECUTION__JIRA_POLLING_INTERVAL_MINUTES | 3 | Minutes between checks of open tickets in Jira. |
FIDES__EXECUTION__REQUIRE_MANUAL_REQUEST_APPROVAL | false | When true, tickets are created at approval instead of in the next polling cycle. |
FIDES__ADMIN_UI__URL | none | The Astralis admin URL, used for __FIDES_REQUEST_URL__ and the OAuth return page. |
FIDESPLUS__JIRA__CLIENT_ID | none | Client ID of your Atlassian OAuth app. OAuth only. |
FIDESPLUS__JIRA__CLIENT_SECRET | none | Client secret of your Atlassian OAuth app. OAuth only. |
FIDESPLUS__JIRA__REDIRECT_URI | none | https://<your-astralis-api>/api/v1/plus/oauth/jira/callback, also registered as the callback URL in your Atlassian app. OAuth only. |
FIDES__EXECUTION__ALLOW_CUSTOM_PRIVACY_REQUEST_FIELD_COLLECTION | false | Stores custom privacy request fields on submitted requests. Required for __CUSTOM_<KEY>__ variables to have values. |
Set up the integration with the API
Step 1: Create the connection
curl -X PATCH 'https://your-astralis-instance.com/api/v1/connection' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '[{
"name": "Jira ticketing",
"key": "jira_ticketing",
"connection_type": "jira_ticket",
"access": "write",
"enabled_actions": ["access", "erasure"]
}]'enabled_actions sets the request types that open a ticket. Without it, every supported request type opens one.
Step 2: Add credentials
Option A: link credentials from your Jira integration. List the Jira integrations you can link to, then link one by its key:
# List Jira integrations whose credentials can be linked
curl -X GET 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/available-saas-connections' \
-H 'Authorization: Bearer <your_access_token>'
# Link the credentials of one of them
curl -X POST 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/link-saas-credentials' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{"saas_connection_key": "jira"}'Option B: set an API token directly.
curl -X PUT 'https://your-astralis-instance.com/api/v1/connection/jira_ticketing/secret' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"domain": "your-domain.atlassian.net",
"username": "jira-service-account@example.com",
"api_key": "<classic Atlassian API token>"
}'Option C: authorize with OAuth. Request an authorization URL, then open it in a browser to grant access:
curl -X POST 'https://your-astralis-instance.com/api/v1/plus/oauth/jira/initiate' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{"connection_key": "jira_ticketing"}'Step 3: Configure the ticket template
Use PATCH to add the template to the stored secrets. A PUT replaces the whole secret, including your credentials.
curl -X PATCH 'https://your-astralis-instance.com/api/v1/connection/jira_ticketing/secret' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{
"project_key": "PRIV",
"issue_type": "Task",
"summary_template": "[__REQUEST_TYPE__] __EMAIL__",
"description_template": "Request __REQUEST_ID__ is due __DUE_DATE__.\nOpen in Astralis: __FIDES_REQUEST_URL__",
"completion_status": "Done",
"due_date_config": {"type": "fixed_days", "days": 30}
}'due_date_config takes {"type": "fixed_days", "days": <n>} or {"type": "policy_timeframe"}. Leave it out or set it to null to use the request's policy deadline. Leave out completion_status to complete on any Done-category status.
Look up the values to use:
# Projects your credentials can see
curl -X GET 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/projects' \
-H 'Authorization: Bearer <your_access_token>'
# Issue types in a project
curl -X GET 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/projects/PRIV/issuetypes' \
-H 'Authorization: Bearer <your_access_token>'
# Statuses for a project and issue type, for completion_status
curl -X GET 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/statuses?project_key=PRIV&issue_type=Task' \
-H 'Authorization: Bearer <your_access_token>'Preview a ticket with sample values, or with a real request by adding privacy_request_id:
curl -X POST 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/preview' \
-H 'Authorization: Bearer <your_access_token>' \
-H 'Content-Type: application/json' \
-d '{"summary_template": "[__REQUEST_TYPE__] __EMAIL__"}'Step 4: Test the integration
# Check credentials, template, and Jira project settings
curl -X GET 'https://your-astralis-instance.com/api/v1/connection/jira_ticketing/test' \
-H 'Authorization: Bearer <your_access_token>'
# Create a real test ticket from sample values
curl -X POST 'https://your-astralis-instance.com/api/v1/plus/connection/jira_ticketing/jira/test-ticket' \
-H 'Authorization: Bearer <your_access_token>'The test ticket is a real Jira issue. Delete it from your project once you've checked it.
API reference
All paths below are under /api/v1/plus and require authentication.
Credentials
| Method | Path | Description |
|---|---|---|
POST | /oauth/jira/initiate | Start the OAuth flow. Returns an authorization_url. |
GET | /oauth/jira/callback | Receives the OAuth callback from Atlassian. Not called directly. |
GET | /connection/{connection_key}/jira/available-saas-connections | List Jira integrations whose credentials can be linked. |
POST | /connection/{connection_key}/jira/link-saas-credentials | Link the credentials of a Jira integration. |
GET | /connection/{connection_key}/jira/link-saas-credentials | Show the current credential link. |
DELETE | /connection/{connection_key}/jira/link-saas-credentials | Unlink the credentials. |
Configuration
| Method | Path | Description |
|---|---|---|
GET | /connection/{connection_key}/jira/projects | List Jira projects. |
GET | /connection/{connection_key}/jira/projects/{project_key}/issuetypes | List issue types for a project. |
GET | /connection/{connection_key}/jira/statuses | List Jira statuses. Filter with project_key and issue_type. |
GET | /connection/{connection_key}/jira/template-variables | List template variables, including custom field variables. |
POST | /connection/{connection_key}/jira/preview | Render a ticket preview. |
POST | /connection/{connection_key}/jira/test-ticket | Create a test ticket in Jira. |
Tickets
| Method | Path | Description |
|---|---|---|
GET | /privacy-request/{id}/jira-tickets | List the Jira tickets linked to a privacy request. |
POST | /privacy-request/{id}/jira-tickets/link | Link an existing Jira ticket. Body: {"ticket_key": "PRIV-456"}. |
POST | /privacy-request/{id}/jira-tickets/{instance_id}/retry | Retry creating a ticket that failed. |
POST | /privacy-request/{id}/jira-tickets/{instance_id}/refresh | Refresh a ticket's status from Jira. |
POST | /privacy-request/{id}/jira-tickets/force-close | Complete the request's pending Jira steps. Body: {"reason": "..."} (optional). |