Manage integrations

Permissions

The Manage Integrations permission is required to view, manage, or delete integrations.

This permission has three levels:

• View only

• View and manage

• View, manage and delete

Make sure you have the correct level to make changes as desired. We recommend limiting the number of people who have the View, manage and delete level to avoid accidentally deleting critical data.

back to top

Adding an integration

To add an integration:

1. Click Add Integration in the top right corner of the Integrations page.

2. Select an integration from the Integration Provider list and Flow will guide you through the integration process.

The steps to successfully connect to each vendor vary slightly depending on the authentication methods available. Refer to the article for your specific vendor for more information.

Data from successfully added integrations will not be available immediately. Flow must first ingest and process your data. Learn more about integration processing statuses to understand how your data is processing.

back to top

Vendor URL templates

Self-hosted git hosts may not provide the correct commit URL to Flow. This prevents Flow from properly linking to that commit. Use the Vendor URL templates page to create and manage your vendor URL templates.

back to top

Updating integrations

Use the Actions for all integrations dropdown menu to apply changes to all integrations. This dropdown is only available if you have the View, manage and delete Manage integrations permission.

• Update all repos: This is useful when credentials have expired and repos have been blocked. Use this option to queue repos for processing after updating your credentials.

• Update background metrics: This is useful when certain activity, like a comment on a PR, isn’t being correctly factored into metric calculations.

• Edit deployment source: Use this if you want to enable or disable git tag tracking for deployments for all integrations. This is only available for git-based integrations.

Performing any of these actions requires Flow to reprocess your data. Changes will not be immediate. Once processing is complete, you’ll see a success banner.

back to top

Deleting integrations

Deleting an integration removes all data associated with that integration. Deletion should be rare and should not be used to edit an integration or solve data issues.

To delete an integration:

1. Select the integration(s) you’d like to delete.

2. Click the Actions dropdown.

3. Click Remove selected.

4. Read the warning and click Delete integration to proceed.

back to top

Viewing and managing an integration

On the Integrations page, use the columns to sort your integrations:

• Integration name: the name given to the integration during integration setup

• Provider: indicates which provider was integrated with

• Services: lists the repos, pull requests, or ticket services that were enabled

• Deployment source: indicates whether git tags are enabled for deployment tracking. For providers with no repo data, this column will be blank
  

• Added by: the Flow user who set up the integration. This may not be the same user whose credentials are used in the integration set up process

  Tip: If you want to see which credentials are used for the integration, click Edit on the integration details page to open the authentication configuration modal.

• Data status: the current health and processing status of the integration. Learn more about integration data statuses

• Last updated: the last time Flow ingested new data from the integration

• View repos/tickets: links to the Repos or Ticket projects page for this integration

To see and edit more details about a specific integration, click the integration name to see the integration details page.

On the integration details page, see:

1. Name: the name of the integration set during the initial integration configuration

2. Connected by: the Flow user who set up the integration

   Note: This may not be the same user whose credentials are used in the integration set up process.

To make changes to the integration, click:

1. Test connection: tests whether the integration connection is successful

2. Update: places all projects, repos, pull requests, and tickets associated with the connection into the queue to be updated

3. Refresh all projects: see new groups, repos, and projects available to import

4. Edit: update the authentication method and credentials

5. Delete (trash can icon): delete the integration

Depending on the vendor, the following tabs are available:

• Repos

  • Toggle on Auto-import all groups if you want all repos in all groups imported automatically.

  • For each group:

    • Toggle on Auto-import to automatically import all repos in the group.

    • Toggle on Show in Repos page to have the repos appear in the Available or Imported tabs of the Repos page.

• Repo exclusions

  • Set up repo exclusion rules

• Tickets

  • Toggle on Auto-import all projects if you want all projects imported automatically.

  • For each project:

    • Toggle on Import to import the project

    • Once a project is imported, configure the ticket project

• Webhooks

  • Set up webhooks

• Services

  • Toggle on or off services available for the integration. Depending on the vendor, available services can include Repos, Pull requests, and Tickets