Jira
export const meta = { title: 'Jira', description: 'Connect Jira to validate access, import work into workflows, and create Jira issues from Canary.', tags: ['integration', 'jira'], };
01What you can do
- Validate your Jira connection
- Import requirements from Jira
- Search Jira issues and import tickets directly into workflows
- Create Jira issues from Canary issues
- Sync Canary issue status updates back to Jira
- Write verified issues from Slack-triggered ad-hoc tests back to Jira as rich comments with replay attachments
- Check webhook health for Jira status sync and repair or re-register sync when needed
02Usage
Use the Jira integration to bring work from Jira into Canary and turn it into test automation faster. You can still import requirements, and you can now start a workflow directly from a Jira ticket import.
You can also search connected Jira tickets directly from Slack assistant threads. Use this path when you need to answer questions about open work or pull ticket details into a Slack conversation without leaving Slack.
Jira also supports issue status sync. When status sync is active, Canary keeps connected Jira issues updated automatically. If sync becomes degraded or stops, use the webhook health controls in Settings to repair the connection or re-register the webhook.
Slack-triggered ad-hoc tests can also write richer verified results back to connected Jira tickets. Use this path when you start test runs from Slack and want the ticket to show the verdict summary, linked verified issues, and direct links back to the Canary run and replay without copying details by hand.
Tagged Jira tickets can also launch ad-hoc tests directly into a specific property. If your organization uses multiple properties, choose the property in Settings > Jira so tagged tickets launch in the right workspace. If you do not set a property, Canary may skip runs from tagged tickets.
Import Jira tickets into workflows
- Open the workflow builder import flow.
- Select Jira.
- Search for the Jira issue you want to use.
- Select the issue to import its ticket details into Canary.
- Review the suggested testing goal and context.
- Continue into the workflow builder.
Canary uses the selected Jira ticket to suggest a starting goal and supporting context, so you can begin authoring a workflow without copying the issue details manually.
Search Jira tickets from Slack assistant threads
- Open a Slack assistant thread.
- Ask the assistant to find a Jira ticket by key, title, or issue details.
- Review the returned Jira results in the thread.
- Continue the conversation using the ticket details you found.
Use this path when your team works in Slack and needs quick Jira lookups during triage, follow-up, or status discussions.
Import requirements from Jira
Use requirement import when you want to bring Jira content into Canary outside the workflow authoring flow. This option remains useful when you are collecting source material before building or updating workflows.
Create Jira issues from Canary issues
Create a Jira issue from a Canary issue when you need to send defects or follow-up work back to your team. This keeps testing output connected to your existing Jira process.
Route tag-triggered ad-hoc tests by property
- Open Settings.
- Select Jira.
- Find the Jira tag-triggered ad-hoc test routing settings.
- Choose the property that should receive tests launched from tagged Jira tickets.
- Save your changes.
- Tag a Jira ticket using your configured trigger.
- Confirm the ad-hoc test appears in the selected property.
Use per-property routing when more than one property shares the same Jira integration or Jira workflow. This keeps tagged ticket runs separated by team, environment, or workspace.
Set this value before you rely on Jira tag-triggered automation in a multi-property organization. If you leave the property unset, tagged tickets may not launch a run.
Comments and issue updates
When a Slack-triggered ad-hoc test tied to Jira completes, Canary can add a richer result comment directly to the Jira ticket. The comment summarizes the verdict, keeps verified issue references clickable, and adds direct links back to the Canary run and replay so your team can review evidence from Jira.
Use Jira comments to share the verified outcome with your team without rewriting the result manually. This helps you keep Slack, Canary, and Jira aligned when you confirm a bug, regression, or follow-up from an ad-hoc run.
Attachments and links
Jira writebacks from Slack-triggered ad-hoc tests can include a verdict summary, linked verified issues, and direct links to the Canary run and replay. Review these details on the Jira ticket when you need to confirm the result, open supporting evidence, or share the outcome with teammates.
Depending on the run output, the Jira ticket can show these artifacts:
| Artifact | What appears on the Jira ticket |
|---|---|
| Rich result comment | A formatted comment that summarizes the ad-hoc test verdict with clickable links |
| Verified issue links | Clickable references to the related verified issue or follow-up context |
| Canary run link | A direct link to the completed Canary run for investigation and sharing |
| Replay link | A direct link to the replay so you can review the test evidence quickly |
| Replay attachment | A replay file or replay reference attached to the ticket for follow-up review |
Monitor and repair Jira status sync
- Open Settings.
- Open your Jira integration settings.
- Review the status sync health shown for the connection.
- If sync is healthy, leave the connection as-is.
- If sync is degraded or inactive, use Repair Sync first.
- If repair does not restore sync, use Re-register to create the webhook again.
- Confirm the status returns to active.
Use Repair Sync when Canary detects that status syncing needs attention but the existing setup can still be fixed. Use Re-register when the webhook is missing or you need to recreate the Jira sync registration from scratch.
If you save Jira defaults that support status syncing, Canary automatically registers the webhook as part of setup. Return to Jira settings any time you need to verify that sync is still active.
03Setup
- Open Settings.
- Select Jira.
- Connect your Jira workspace and complete the authorization flow.
- Validate that the connection succeeds.
- Save your Jira defaults.
Saving your Jira defaults also enables Canary to register the webhook used for Jira issue status sync when your connection supports it. After setup, review the sync health in Jira settings to confirm the webhook is active.
04Configuration
Note: If your organization uses multiple properties, select a property for tag-triggered ad-hoc tests before you rely on Jira ticket tags to launch runs. If you leave this unset, Canary may skip runs from tagged tickets.
Use Jira settings to manage both the connection and issue status sync behavior.
| Setting area | What it does |
|---|---|
| Connection validation | Confirms Canary can access your Jira workspace |
| Default Jira settings | Saves the Jira defaults Canary uses for connected work |
| Tag-triggered ad-hoc test routing | Selects which property receives tests launched from tagged Jira tickets |
| Status sync health | Shows whether Jira issue status sync is active, degraded, or inactive |
| Repair Sync | Attempts to restore Jira status sync without recreating the full setup |
| Re-register | Creates the Jira webhook again when sync is missing or cannot recover |
If your organization uses multiple properties, set the tag-triggered ad-hoc test routing value to control where Jira-tagged tickets launch their runs. Review this setting any time you add a property, change ownership between teams, or update the Jira workflow that applies the tag.
If your organization uses one property, review the routing value anyway to confirm tagged tickets still launch where you expect.
Review the status sync health after making changes to your Jira configuration. If you see a degraded state, repair sync before reconnecting the entire integration.
05Troubleshooting
Use these checks if Jira import or reframing does not complete as expected.
| Problem | What to do |
|---|---|
| You cannot find the Jira issue you want to import | Confirm the issue exists in the connected Jira project and that your Jira connection has access to it. Then run the search again with the issue key or a more specific title. |
| The import dialog is hard to read for long ticket content | Retry the import and review the full ticket content in Jira if needed. Long-content display issues have been improved, but checking the original issue can help confirm what should be imported. |
| Canary shows an import error | Re-open the import flow, verify your Jira connection, and try the import again. If the issue continues, revalidate the integration before retrying. |
| Canary shows a reframing error after import | Import the ticket again and review the issue summary and description for enough detail to generate a testing goal. If the ticket is sparse or unclear, add more context in Jira and retry. |
| Tagged Jira tickets do not launch ad-hoc tests | Open Settings > Jira and confirm Tag-triggered ad-hoc test routing is set to the correct property. Save the setting, tag the ticket again, and confirm the run appears in the selected property. |
| Tagged Jira tickets sometimes launch in the wrong property | Review Settings > Jira and update Tag-triggered ad-hoc test routing to the property that should receive tagged-ticket runs. Re-test with a new tagged ticket after saving the change. |
| Jira status sync shows as degraded or inactive | Open Settings > Jira, review the sync health, and click Repair Sync. If sync does not recover, click Re-register to recreate the webhook and then confirm the status returns to active. |
| Jira status updates stop syncing after setup | Confirm your Jira defaults are still saved, then open Settings > Jira and check the webhook health. If the webhook is missing, use Re-register to restore automatic status syncing. |