How to Set Up Integrations
Connect BugBrain with your team’s tools to get notifications about test results and streamline your workflow.
Available Integrations
- Slack - Send notifications to Slack channels
- Jira - Create issues for failed tests
- Microsoft Teams - Post results to Teams channels
- Trello - Create cards for test failures
- Webhooks - Custom integrations via HTTP
General Setup Process
All integrations follow a similar pattern:
Integration-Specific Guides
Slack Setup
What you’ll need: Slack workspace with permission to add apps
1. Get Webhook URL from Slack:
- Visit https://api.slack.com/apps
- Click ‘Create New App’
- Choose ‘From Scratch’
- Enable ‘Incoming Webhooks’
- Add webhook to your workspace
- Copy the webhook URL
2. Configure in BugBrain:
- Add Slack integration
- Paste webhook URL
- Choose notification channel
- Select events to notify about
- Test and save
Jira Setup
What you’ll need: Jira account with permission to create issues
1. Get Jira API Token:
- Go to https://id.atlassian.com/manage-profile/security/api-tokens
- Click ‘Create API token’
- Give it a label (e.g., “BugBrain”)
- Copy the token
2. Configure in BugBrain:
- Add Jira integration
- Enter Jira site URL (e.g., yourcompany.atlassian.net)
- Enter your Jira email
- Paste API token
- Select project and issue type
- Test and save
Microsoft Teams Setup
What you’ll need: Teams with permission to add connectors
1. Get Webhook URL from Teams:
- Open the Teams channel
- Click ’…’ → Connectors
- Search for ‘Incoming Webhook’
- Click ‘Configure’
- Name it “BugBrain”
- Copy the webhook URL
2. Configure in BugBrain:
- Add Teams integration
- Paste webhook URL
- Select notification events
- Test and save
Trello Setup
What you’ll need: Trello account with access to a board
1. Get Trello API Key and Token:
- Visit https://trello.com/app-key
- Copy your API key
- Click the token link to generate a token
- Authorize BugBrain access
2. Configure in BugBrain:
- Add Trello integration
- Enter API key and token
- Select board and list for cards
- Choose event triggers
- Test and save
Webhooks Setup
What you’ll need: A server endpoint that accepts POST requests
1. Prepare Your Endpoint:
- Create an HTTP endpoint that accepts POST requests
- Ensure it can handle JSON payloads
- Implement authentication if needed
2. Configure in BugBrain:
- Add Webhook integration
- Enter webhook URL
- (Optional) Add authentication headers
- Select events to send
- Test and save
Configuring Notification Events
For each integration, choose which events trigger notifications:
Recommended Events
| Event | When to Enable |
|---|---|
| Test Failed | ✅ Always recommended - alerts team to issues |
| Test Completed | Only for critical tests - can be noisy |
| Discovery Completed | ✅ Good for scheduled discoveries |
| Test Plan Completed | ✅ Recommended for batch runs |
Event Filters
Control which tests trigger notifications:
By Priority:
- Only critical and high priority tests
- All tests
- Custom priority selection
By Tags:
- Only tests with specific tags (e.g., “smoke”, “critical”)
- Exclude certain tags
By Status:
- Only failures
- Only passes
- Both
Prevent Notification Fatigue: Start with just failure notifications for critical tests. You can always enable more events later.
Testing Integrations
Always test before enabling:
- Click ‘Test Integration’ button
- Check your tool (Slack, Jira, etc.)
- Verify the test message arrived
- Check formatting and content
- Adjust settings if needed
Example test message:
🧪 BugBrain Integration Test
This is a test notification from BugBrain.
If you can see this, the integration is working correctly!
Project: My Website
Integration: SlackManaging Multiple Integrations
You can have multiple integrations per project:
Example setup:
- Slack #engineering-alerts → Critical test failures only
- Slack #qa-results → All test completions
- Jira → Automatic issue creation for failures
- Webhook → Custom CI/CD pipeline integration
Troubleshooting
Integration Not Working?
1. Check Credentials
- Verify API keys/tokens are correct
- Ensure tokens haven’t expired
- Check for typos in webhook URLs
2. Test the Integration
- Use the ‘Test Integration’ button
- Check for error messages
- Verify the test notification arrives
3. Check Permissions
- Ensure API tokens have required permissions
- Verify you can post to channels/boards
- Check firewall/security settings
4. Review Filters
- Make sure event filters aren’t too restrictive
- Check that test priorities match filter settings
- Verify tags are correctly configured
Common Issues
Slack: “Webhook URL invalid”
- Make sure you copied the complete URL
- URL should start with
https://hooks.slack.com/ - Regenerate webhook if needed
Jira: “Authentication failed”
- Double-check email address
- Regenerate API token
- Ensure user has project permissions
Teams: “Unable to post message”
- Verify webhook URL is correct
- Check if connector was removed from channel
- Recreate connector if needed
Webhooks: “Connection timeout”
- Verify endpoint is publicly accessible
- Check firewall rules
- Ensure server is running
Best Practices
1. Start Simple Set up one integration at a time and verify it works before adding more.
2. Use Dedicated Channels Create specific channels for test notifications (#test-results, #qa-alerts).
3. Filter Appropriately Only notify on events that require attention to avoid alert fatigue.
4. Test Regularly Periodically test integrations to ensure they’re still working.
5. Document for Your Team Let team members know what notifications to expect and where.
6. Monitor Integration Health Check integration logs periodically for any errors or issues.
Security Considerations
- API Keys: Never share API keys or tokens publicly
- Webhooks: Use HTTPS for all webhook URLs
- Credentials: Credentials are encrypted at rest in BugBrain
- Rotation: Rotate API keys periodically for security
- Permissions: Grant minimum required permissions