The Integrations page makes it easy to see and manage all of your connected accounts. Below is an overview of how to manage and add integrations and the data that is brought in from each one.
The first time you login to your Flow account, you will be prompted to create an integration to begin connecting your repos. Select your Git host from the list below or Generic Repo to import repos via an SSH or HTTPS clone URL.
Managing your integrations
Once you have added integrations you will find all of your integrations and connected accounts by clicking Settings from the top navigation then under Integrations, click Integrations.
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.
- Re-order your list by any of 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
Delete an integration
At any point you may delete an integration from the Integration page. This will remove all data associated with that integration.
Select the integration you would like to delete and click Remove Selected from the drop down menu.
A warning message will appear asking you to confirm your selection. Click Yes, remove integration data.
Success! The integration has been successfully deleted and will no longer appear in your integrations list. All of the associated data from the integration has been removed from your account.
Adding an integration
You can add an integration by clicking Add Integration in the top right hand corner of your screen.
Select the Integration you would like to create. You will then be walked through steps to establish the account connection. Please see the specific integration help doc for more information.
Important: Once your integrations are connected, it may take up to 24 hours to ingest all your Repo, PR and ticket data into Flow.
Integrations Update Actions
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, PRs, tickets, 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 all PRs: Full reprocess of all pull request projects.
- Update all tickets: Full reprocess of all ticket projects.
- 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.
After you’ve clicked one of these options, the processing could take up to an hour or more. Once completed, all your integrations will have reprocessed and you’ll see a green banner on top of your screen.
By selecting View repos or View tickets from any of your Integrations, you will be directed to the Repo page or Ticket page where you will see all of the repos or ticket projects that have been imported from this integration.
Click View repos or View tickets from the integration you want to view repos or tickets for. In this example we select View repos.
You will then be directed to your Imported repos tab, where you will see only the imported repos associated with that integration you selected.
Selecting and viewing an integration
By selecting any of the Integrations in your list, you can view and manage the Integration’s settings.
Locate and click the integration you would like to manage.
On the individual Integration page you will will be able to do the following:
- Rename the integration - You can rename the integration by clicking on the integration name in the top left. This action will save automatically.
- Test the integration connection - Clicking Test connection will test the connection to make sure it is still connected correctly.
- Update the integration - Clicking Update now will 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/or new repos that are available for import.
- Manage the integration’s services - depending on the connection these services can vary (see below).
- Remove the integration
You can also enable Auto import all groups, as shown below. Toggling this on, allows auto importing of 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.
Manage the integration’s services
Each integration will have 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*
In the example below we are reviewing a Bitbucket cloud Integration, so we can review each service.
In this tab you will be able to install webhooks for each repo (Bitbucket) or for the account (GitHub).
Select which repos or account you would like to install webhooks for. You can do this individually or in bulk.
Step 2: Success! Webhooks have been installed.
What if I can’t install webhooks?
If you are unable to install webhooks you may get the following error:
Step 1: If you see this error click Upgrade now and you will be prompted to upgrade the permissions that Flow currently has with that provider. In this example, we are upgrading our permissions from GitHub.
Step 2: A pop-up will appear asking you to authorize Flow with the new permissions. Click Authorize Git-Prime.
Step 3: 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 this tab you will be able to:
- 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.
By toggling the Auto-import button “On”, all repos for that particular account will be automatically imported. This includes all existing repos and any repos you add in the future.
Show or hide projects/groups on the organization repo import page.
If you wanted to hide or remove an account or organization and all it’s associated repos from the Available tab of your repos page, you can do this by toggling the Show in Repos page button off.
Pause or delete all repos
Under Services you have the option to:
- Pause repo services - this will stop all updating and importing, but all data will remain in your account. At any point you may Resume repo services.
- Turn off (delete) repo services - this will delete all repos that have been imported, and any data that has been previously processed, including PR and Ticket data. It will also remove the integration from your Available repos list.
When turning off repo services will get the following warning:
Ticket & 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 (delete) these services. In the images below we are using the Tickets tab as the example.
- Pause services - this toggle will stop all updating and importing, but all data will remain in your account. At any point you may Resume services.
- Delete all ticket data - this will delete all tickets/Pull Requests that have been imported.
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, you can 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 firstname.lastname@example.org for 24/7 assistance.