Integrations
In Settings > Integrations, your organization connects Proton to the tools it already uses: git with the automation code, Jira, Xray and Zephyr, BrowserStack and Firebase. Each integration stores the tool's address and credentials, and unlocks the parts of the portal that depend on it.
From Proton to your company
At the top of the screen, From Proton to your company leads the other way: Proton's data in the company's tools.
- Query API (in Settings > Query API): runs, logs, indicators and exceptions in the data warehouse, Power BI and dashboards, with a read-only token. See Monitoring and Data Warehouse.
- Webhooks (on the Webhooks tab of Settings > Alerts and webhooks): events as they happen, signed, for monitoring and ticketing. See Webhooks.
Both are part of the Enterprise plan.
What each integration connects
| Integration | Category | Fields | What it connects in Proton |
|---|---|---|---|
| GitHub | Version Control | Organization (optional, only for the test) and Token | Repositories on GitHub.com. |
| GitLab | Version Control | Base URL (empty for gitlab.com) and Token | Repositories on gitlab.com or on a company GitLab. |
| Bitbucket | Version Control | Workspace, Username and Access Key | Repositories on Bitbucket Cloud. |
| Jira | Project Management | Base URL, Email and API Token | Requirements, bugs and the Jira columns in traceability. See Jira. |
| Xray | Test Management | Base URL, Client ID and Client Secret, plus the projects | Results publishing, Tests, Test Plan import and runs started from Jira. See Xray and Zephyr. |
| Zephyr | Test Management | Base URL, API region, API Token and the projects | The same as Xray, with Zephyr's names. |
| BrowserStack | Test Infrastructure | Username and Access Key | Cloud devices when you start a run, and app uploads. See Mobile Apps. |
| Firebase | App Distribution | Project ID and the Service Account Key (JSON) | Importing App Distribution releases into Mobile Apps. |
The screen also offers Azure DevOps, SauceLabs, Synthesized, Slack and Teams. You can register them, but no Proton screen uses these integrations yet.
Jira, Xray and Zephyr must be cloud versions (Jira Cloud, at https://yourcompany.atlassian.net). The Data Center and
Server editions are not supported.
Register
Add opens Create Integration:
- Select the platform from the cards.
- Under General, enter the Name and fill in the platform's address or context field.
- Under Authentication, fill in the credentials. Secret fields are masked, with an eye icon to check them.
- For Xray and Zephyr, enter the Jira Projects (their keys, such as QA) and the Default project, which the screens show already selected. For Zephyr, also choose the Zephyr API region, the same as your Jira Cloud (if unsure, United States).
- Test Connection checks the credentials before you save. Save.
Credentials are encrypted in Proton and never come back to the screen. When editing, the type can't change, and the credentials are only replaced through Update Credentials (or kept with Keep current credentials).
:::tip Use a service account For the credentials, prefer a technical user of the tool over a person's account: the integration doesn't stop working when someone leaves the company. :::
The list
The cards show the name, type, category, address, last validation date and status (Active or Error). Search and the filters (Active, With error) help you find an integration.
Test Connection, on the card, tests the saved credentials and updates the status. The test actually checks the credentials for GitHub, GitLab, Jira, Xray, Zephyr, BrowserStack and Firebase.
After you register Jira, Xray or Zephyr, their features can take up to a minute to show up in the portal.
Delete
Before deleting, check what depends on the integration:
- a git integration used by a repository can't be deleted: switch the repository to another integration first;
- deleting Jira, Xray or Zephyr deletes, in Proton, the linked requirements and bugs, the group publishing settings, the links between datasets and Tests, and the publishing history. Nothing changes in Jira.
Git integrations
The full path for the code, from the integration to the runner, is in Systems and repositories. In short: register the integration with the token, register the repository using that integration, link the system to the repository and choose the branch when you start the run.
The token needs to read the automation repositories and list their branches. In repositories marked as BDD on GitHub,
Proton also creates the proton-bdd branch, so the token needs write access.
Permissions and mobile
Viewing, creating, editing and deleting integrations are permissions of the Integration entity, in the profile's Configuration tab. Testing the connection of a saved integration requires edit permission.
The screen is designed for desktop. The Jira, Xray and Zephyr features in the run details and in traceability work on mobile.