Overview
The Integration Hub is your central location for connecting Backline with your existing development and security tools. By integrating with your source control management (SCM) platforms, security scanners, and collaboration tools, Backline can automatically collect vulnerabilities and streamline your remediation workflow.Accessing the Integration Hub
1
Navigate to Integrations
Click Integrations in the main navigation menu.
2
Browse Available Integrations
View all available integration options displayed as cards.
3
Select an Integration
Click on the Connect button of any integration card to begin the connection process.
Available Integration Types
Source Control Management (SCM)
Connect your code repositories to enable Backline to access your codebase and create remediation pull requests:Container Registries
Integrate container registries to scan images for vulnerabilities:Package Registries
Connect package registries to monitor dependencies:Security Scanners
Import vulnerability from security scanning tools:Collaboration Tools
Link collaboration platforms for notifications and ticket management:Connecting an Integration
When you click Connect on an integration card, a dialog will open to guide you through the connection process.Integration Dialog
The integration dialog provides all the information and tools needed to connect your integration:Overview Tab
The Overview tab contains:- Overview: Description of the integration, its benefits, and features
- Connection Instructions: Step-by-step guidance for connecting the integration
- Click the Connect button to be redirected to the service provider
- Authorize Backline and grant the requested permissions
- You’ll be redirected back to Backline with the integration connected
- Click the Connect button to be redirected to install the required app
- Follow the installation process on the service provider’s platform
- Return to Backline once the app is installed
- Fill in the required credential fields (API keys, tokens, URLs, etc.)
- Click Connect to establish the connection
- Use Test Connection to verify the credentials are correct
Configuration Tab
The Configuration tab only appears for integrations that have additional, non-mandatory configuration options available.
- Set optional features and preferences
- Customize integration behavior
- Configure advanced settings
Managing Integrations
View Integration Status
Each integration card shows its connection status through the action button:- “Connect” button: Integration is not yet connected
- “Configure” button: Integration is already connected
Viewing and Editing Integration Settings
For connected integrations, you can view and manage settings:1
Click Configure
On a connected integration card, click the Configure button.
2
Review Connection Details
View the existing connection details and configuration settings.
3
Test Connection
Use the Test Connection button to verify the integration is working properly.
4
Check Configuration
Review all configuration options and make any necessary adjustments.
Disconnect an Integration
To remove an integration:1
Open Integration Menu
On the integration card, click the three dots menu (⋮) in the corner.
2
Select Disconnect
Click the Disconnect option from the menu.
3
Confirm
Confirm that you want to remove the integration.
Best Practices
Start with SCM
Start with SCM
Connect your source control management platform first (GitHub, GitLab, or Bitbucket) as it’s required for automated remediation features.
Add Multiple Scanners
Add Multiple Scanners
Connect all your security scanning tools to get a comprehensive view of vulnerabilities across your entire stack.
Test Connections
Test Connections
Always use the Test Connection button before saving to ensure your configuration is correct.
Secure Your Credentials
Secure Your Credentials
When using API keys or tokens, ensure they have only the minimum required permissions and store them securely.
Troubleshooting
Connection Failed
If an integration fails to connect:- Verify your credentials are correct
- Check that the service is accessible from your network
- Ensure you have the necessary permissions in the external service
- Review any error messages for specific guidance
OAuth Authorization Issues
If OAuth authorization fails:- Clear your browser cache and cookies
- Ensure pop-ups are allowed for Backline
- Try the authorization process again
- Check that your account has admin rights in the external service