Jira Integration
Connect BugBrain to Jira to automatically create issues when tests fail, sync test status, and keep your team in the loop.
What Can You Do?
Automatic Issue Creation
When tests fail, BugBrain can:
- Create Jira issues automatically
- Include test details, screenshots, and logs
- Assign to the right team member
- Set priority based on test importance
- Link to test execution results
Two-Way Sync
Keep everything in sync:
- Test status updates in Jira
- Jira issue status updates in BugBrain
- Comments sync between platforms
- Linked issues visible in both tools
Smart Deduplication
Avoid duplicate issues:
- Groups similar failures together
- Only creates one issue per unique bug
- Updates existing issues on reoccurrence
- Tracks failure frequency
Setting Up Jira Integration
Prerequisites
You need:
- Jira Cloud or Jira Server account
- Admin permissions in Jira
- Admin or owner role in BugBrain
- Available on Growth and Pro plans
Step 1: Generate Jira API Token
For Jira Cloud:
- Go to Atlassian Account Settings
- Click “Create API token”
- Name it “BugBrain Integration”
- Copy the token (save it - you won’t see it again!)
For Jira Server/Data Center:
- Go to Jira → Settings → Applications
- Create a new Application Link
- Use OAuth or Personal Access Token
- Copy credentials
Step 2: Connect to BugBrain
- Go to BugBrain → Settings → Integrations
- Click “Connect” next to Jira
- Enter your details:
- Jira URL: Your Jira instance URL (e.g.,
https://yourcompany.atlassian.net) - Email: Your Jira account email
- API Token: The token from Step 1
- Jira URL: Your Jira instance URL (e.g.,
- Click “Connect”
- BugBrain will verify the connection
Tip: Use a service account or dedicated integration user in Jira, not your personal account. This ensures the integration keeps working even if your access changes.
Step 3: Configure Issue Creation
Choose when to create issues:
Trigger Options:
- Every failure - Issue for every failed test
- Recurring failures - Only after X consecutive failures
- New failures - Only for tests that previously passed
- Critical failures - Only for high-priority tests
- Manual only - Only when you click “Create Issue”
Configure:
- Go to Settings → Integrations → Jira → Configure
- Select trigger type
- Set failure threshold (if using recurring)
- Enable/disable for specific projects
- Save settings
Step 4: Map Fields
Map BugBrain data to Jira fields:
Required Mappings:
- Project - Which Jira project to create issues in
- Issue Type - Bug, Task, Story, etc.
- Priority - Map test priority to Jira priority
Optional Mappings:
- Assignee - Auto-assign to specific user or team
- Labels - Add labels like “automated-test”, “bugbrain”
- Components - Map to Jira components
- Fix Version - Target release version
- Custom Fields - Map to your custom fields
Example mapping:
Test Priority → Jira Priority
- Critical → Highest
- High → High
- Medium → Medium
- Low → LowStep 5: Test the Integration
- Go to Settings → Integrations → Jira
- Click “Test Connection”
- Select a failed test execution
- Click “Create Test Issue”
- Verify issue appears in Jira
Using the Integration
Automatic Issue Creation
When a test fails:
- BugBrain checks trigger conditions
- If met, creates Jira issue automatically
- Populates issue with test details
- Links issue to test execution
- Sends notification (if enabled)
Issue includes:
- Test case name and description
- Failure reason and error message
- Screenshots of failure point
- Test steps performed
- Environment details
- Link back to BugBrain execution
Manual Issue Creation
Create issues on demand:
- Go to test execution that failed
- Click “Create Jira Issue”
- Review auto-filled details
- Modify if needed
- Click “Create”
Use case: For selective issue creation or adding context before creating.
Viewing Linked Issues
See Jira issues linked to tests:
In Test Execution:
- “Linked Issues” section shows all related Jira issues
- Click to open in Jira
- See issue status and assignee
In Test Case:
- View all issues created from this test
- Track which issues are resolved
- See failure patterns
Updating Issues
Update Jira issues from BugBrain:
Auto-updates:
- Test passes → Add comment to issue
- Test fails again → Add comment with new details
- Frequency changes → Update issue description
Manual updates:
- Add comments from BugBrain
- Change status
- Update priority
- Add attachments
Issue Templates
Customize issue content:
Title Template
Default: [BugBrain] {{testName}} failed
Variables:
{{testName}}- Test case name{{project}}- Project name{{priority}}- Test priority{{environment}}- Environment tested
Example: [{{priority}}] {{testName}} - {{environment}}
Description Template
Customize issue body:
## Test Failure
**Test:** {{testName}}
**Project:** {{project}}
**Priority:** {{priority}}
**Environment:** {{environment}}
## Failure Details
{{errorMessage}}
## Steps to Reproduce
{{testSteps}}
## Screenshots
{{screenshots}}
## Additional Info
- **Execution ID:** {{executionId}}
- **Failed at:** {{failedAt}}
- **View in BugBrain:** {{executionUrl}}Configure:
- Settings → Integrations → Jira → Issue Template
- Edit title and description templates
- Use variables for dynamic content
- Preview before saving
Advanced Features
Issue Transitions
Auto-transition Jira issues:
Rules:
- Test passes → Close issue (or move to “Resolved”)
- Test fails again → Reopen issue
- Test deleted → Close issue with comment
Configure:
- Settings → Integrations → Jira → Transitions
- Map test events to Jira workflows
- Enable/disable automatic transitions
Smart Deduplication
Avoid duplicate issues:
How it works:
- Test fails
- BugBrain checks if similar issue exists
- If found, updates existing issue
- If not, creates new issue
Similarity detection:
- Same test case
- Same error message
- Within time window (7 days default)
Configure deduplication:
- Settings → Integrations → Jira → Deduplication
- Set similarity threshold
- Set time window
- Enable/disable per project
Bulk Issue Creation
Create multiple issues at once:
- Go to Test Executions
- Filter by failed status
- Select multiple executions
- Click “Create Jira Issues”
- Review and create in bulk
Use case: After a test run with multiple failures, create all issues at once.
Issue Comments from Tests
Add context to Jira issues:
From test execution:
- Open failed execution
- Find linked Jira issue
- Click “Add Comment”
- Type comment (markdown supported)
- Comment appears in both BugBrain and Jira
From team members:
- Developers can add comments in Jira
- Comments sync back to BugBrain
- Everyone stays updated
Filtering and Rules
Project-Specific Settings
Configure per project:
- Go to Project Settings → Integrations
- Click Jira
- Override global settings:
- Different Jira project
- Different issue type
- Custom field mappings
- Different triggers
Tag-Based Rules
Create issues based on tags:
Example rules:
- Tests tagged “smoke” → Create issues immediately
- Tests tagged “flaky” → Only create after 3 failures
- Tests tagged “low-priority” → Manual creation only
Configure:
- Settings → Integrations → Jira → Rules
- Add new rule
- Set tag condition
- Set action
- Save rule
Notifications
Get notified about Jira integration events:
Notification types:
- Issue created
- Issue updated
- Issue closed
- Integration errors
Configure:
- Settings → Notifications
- Enable Jira notifications
- Choose channels (email, Slack, Teams)
- Set notification preferences
Troubleshooting
Connection Issues
“Invalid credentials” error:
- Verify API token is correct
- Check Jira URL format
- Ensure email matches Jira account
- Try regenerating API token
“Permission denied” error:
- Verify you have admin permissions
- Check Jira project permissions
- Ensure API token has required scopes
Issue Creation Fails
“Required field missing” error:
- Check field mappings in settings
- Ensure all required Jira fields are mapped
- Verify custom field IDs are correct
“Project not found” error:
- Verify Jira project key is correct
- Check project permissions
- Ensure project exists and is accessible
Sync Issues
Issues not syncing:
- Check webhook configuration in Jira
- Verify network connectivity
- Review integration logs in Settings
- Test connection manually
Duplicate issues created:
- Review deduplication settings
- Check time window configuration
- Verify similarity threshold
- Look for timing issues
Best Practices
1. Use Service Account Create a dedicated Jira user for the integration, not a personal account.
2. Start Selective Begin with manual issue creation or high-priority tests only. Expand as you refine the process.
3. Customize Templates Tailor issue templates to match your team’s workflow and information needs.
4. Review Regularly Periodically review created issues to ensure they’re useful and not creating noise.
5. Enable Deduplication Avoid duplicate issues by enabling smart deduplication with appropriate settings.
6. Set Clear Ownership Configure auto-assignment rules so issues land with the right team or person.
Security & Privacy
Data shared with Jira:
- Test case names and descriptions
- Failure details and error messages
- Screenshots (if enabled)
- Environment information
- User names (who ran tests)
Data NOT shared:
- Sensitive credentials or secrets
- Unrelated test executions
- Organization settings
- Billing information
API token security:
- Stored encrypted in BugBrain
- Never logged or exposed
- Can be revoked anytime in Jira
- Rotated periodically recommended
Quota & Limits
API rate limits:
- Jira Cloud: 200 requests/minute
- BugBrain caches data to stay within limits
- Bulk operations are batched
Issue limits:
- No limit on issues created
- Counts toward your Jira quota
- Consider deduplication to reduce volume
Next Steps
- Set up Slack integration for notifications
- Configure webhooks for custom workflows
- Learn about test notifications
- Explore team management