Who can use this?
The Manage integrations permission is required to view, manage, or delete integrations.
Managing your integrations
To find your added integrations:
- Click Settings in the top navigation.
- In the left navigation, under Integrations, click Integrations.
Note: Learn more about Integrating hosts, including step-by-step walkthroughs for specific hosts.
On the Integrations page you can do the following:
- Search or filter by integration: Using the advanced filtering you can narrow down your integrations list.
- Sort your integrations by using the columns Integration Name, Provider, Services, Added by and Last Updated.
- Delete an integration
- Add another integration
- View repos or ticket projects
- Select and view an integration
- Review and edit the Vendor URL for a commit
Deleting an integration removes all data associated with that integration. Deleting an integration should be rare and should not be used to edit an integration or solve data issues. You will not be able to add the integration back to Flow for 24 hours or more and you may have to merge your users again.
To delete an integration:
- Select the integration you want to delete.
- Click the Actions dropdown.
- Click Remove Selected.
- A warning message appears asking you to confirm your selection. Click Delete integration.
You successfully deleted the integration. It no longer appears in your integrations list and Flow removed all of its associated data from your account.
Adding an integration
To add an integration:
- Click Add Integration in the top right corner of the Integrations page.
- Select an integration from the Integration Provider list and Flow will guide you through the integration process. Learn more about adding specific integrations.
Important: New integrations may take up to 24 hours to ingest all your Repo, PR and ticket data into Flow.
On the top right-hand side of the Integrations page, you’ll find the Integrations Update Actions dropdown menu. Depending on which button you press, this will trigger a full reprocess of either repos or background metrics calculations.
Note: For best results, perform this update only when necessary to reduce reprocessing time.
The Update actions options have the following effects on your existing integrations:
- Update all repos: This is useful when your credentials have expired and repos have been blocked. You can use this button to get repos through processing, after updating your credentials.
- Update background metrics: This is used when, for example, a comment exists on a PR, but isn’t being factored into a PR metric.
Important: These commands are only available to those users who have Manage Integrations: view, manage, and delete permissions.
The processing for each update option could take up to an hour or more. Once processing is completed, a green success banner appears on your screen.
Viewing repos and tickets
To view repo and ticket projects that were imported from an integration:
- Navigate to the integrations page.
- Click View repos or View tickets next to an integration.
- You are directed to the Repo page or Ticket page where you will see all of the repos or ticket projects that were imported from this integration.
- Select the Imported repos tab. You will see only the imported repos associated with that integration you selected.
Tip: Click Clear all filters to remove the filter and view all imported repos. Learn more about managing repositories.
Viewing an integration
Click an integration name to view and manage the Integration’s settings.
On the individual Integration page you can:
- Rename the integration.Click the integration name in the top left to rename it. This action automatically saves.
- Test the integration connection. Click Test connection to test the connection and make sure it is still connected correctly.
- Update the integration. Click Update now to place all projects, repos, pull requests and tickets associated with that connection into the queue to be updated.
- Refresh all projects. Click Refresh all projects to see new groups and new repos available for import.
- Manage the integration’s services. Depending on the connection, these services can vary.
- Remove the integration.
- Auto import all groups. Toggle on to auto import all groups in this particular integration. If you’d like to enable or disable the import of any group individually, toggle Auto import all groups off. Then use the Auto import column to select specific integrations to auto import.
Note: Auto import all groups only imports the repos displayed under Groups for the specific integration you’re working with.
Managing an integration’s services
Each integration has associated services. Depending on the integration, these services can vary. Here is a general guideline:
Cloud Git Hosts (Bitbucket, GitHub, Git Lab, Azure)
- Pull Requests
Self-hosted or behind a firewall (*services may vary)
- Pull Requests*
Navigate to the Webhooks tab to install webhooks for each repo or for the account.
Select which repos or account you would like to install webhooks for. You can do this individually or in bulk. If it was successful, you will see a check in the Installed column.
What if I can’t install webhooks?
If you are unable to install webhooks you may get the following error:
If you see this error:
- Click Upgrade now. You will be prompted to upgrade the permissions that Flow currently has with that provider.
- Click Authorize Git-Prime in the pop-up that follows. This authorizes Flow with the new permissions.
- Once you have authorized Flow, you will be able to install webhooks for your account’s repos.
You can remove your installed Webhooks by selecting the repo or account you would like to remove and select Remove selected from the drop down menu.
In the repos tab:
- Control which accounts and organizations you want to auto-import repos from.
- Control which groups and organizations that are associated with your Integration, are visible on the Available tab of your repos page.
- Pause or delete all repos that have been imported from this integration.
Toggle the Auto-import button On to automatically import all repos for that particular account. This includes all existing repos and any repos you add in the future.
Show or hide projects and groups on the organization repo import page.
To hide or remove an account or organization and all its associated repos:
- Navigate to the Repos page.
- Click the Available tab.
- Toggle the Show in Repos page button to off.
Pause or delete all repos
Under Services you have the option to:
- Pause repo services. This stops all updating and importing, but all data will remain in your account. At any point you may Resume repo services.
- Turn off repo services. This deletes all imported repos, and any data previously processed, including PR and Ticket data. It also removes the integration from your available repos list.
Tip: It does not delete the Integration itself, it only removes any associated data.
When turning off repo services will get the following warning:
Ticket and Pull Requests Services
In the Services tabs you will be able to enable and disable ticket/PR services for the Integration. Just like Repos, you can pause or turn off these services. In the images below we are using the Tickets tab as the example.
- Pause services. This toggle stops all updating and importing, but all data remains in your account. At any point you may Resume services.
- Delete all ticket data. This deletes all imported tickets and Pull Requests.
When turning off ticket services will get the following warning:
Review and edit the Vendor URL for your commits
Self hosted git hosts and commits may not provide the correct commit URL to Flow. This prevents Flow from properly linking to that commit.
Use the Vendor URL page to review and edit the vendor URL.
From the integrations page, click the Vendor URLs button.
On the Vendor URL templates page, review the vendor URLs and see which commits are not yet configured. Use this page to review, configure, and modify the Vendor URLs.
- The Hostname column provides the name of the host for your commit. The hostname is used to populate the Host variable in the URL template.
- The Commit URL column shows the URL template linking to the commit. If Flow does not have the URL template, you will see the Not yet configured alert. Use this column to make sure Flow has the correct URL template.
- The Integrations affected column shows the integrations that use the host name. Each of these integrations use this template to link to their commits.
- The Last updated column shows the date the URL was last updated.
- The Edit column allows you to edit the URLs.
How do I edit the Vendor URL?
- Navigate to the Vendor URL’s page.
- Click the Edit icon next to the URL you want to edit.
- You will see a pop up modal, where you can edit the URL. When you are done, click Update.
- Use the Hostname field to edit the host name of your commit. The hostname field is pre-populated based on the hostname provided to Flow.
- Use the Commit URL template field to edit the commit URL. When you click inside the field, you will see URL template variables. Click the variable you want to edit.
- The Variables and their meanings section provides the variable names for the URL and their definition. Click on a variable name to populate that variable field in the Commit URL template field.
- Use the provided URL to verify the URL is correct. The URL will update in realtime as you update the template.
If you need help, please email Support (opens email form) for 24/7 assistance.