Connecting Your Tools

The platform signs in to other services to do its work: one to read the product's code and pull requests, one to read its tickets, and one for each destination it publishes to. Each of these sign-ins is a connection. Each product chooses which connection it uses for each job, so different teams can use different accounts.

Reading a connection

Each connection has a card:

  1. Check connection: Checks the connection again (signed-in administrators only).
  2. Connected: The connection's status. Connected means its last check succeeded; Error or Needs re-authorization means it needs attention.
  3. Last checked and Used by: When the platform last asked the service which account the credentials belong to, and which products use the connection, and for what.
A connection's card with the Check connection button, its status, and its last check and products marked A to C

Signed-in administrators also see the account it signs in as, the site it connects to, the message from its last check and its recent activity. These details are hidden from anyone who is not signed in. When a connection stops working, Connections in the sidebar shows how many connections are failing.

To add a connection:

1. Click Connections

The Connections item in the sidebar

2. Click Add a connection

The Add a connection section, closed

3. Choose the Account type. The list shows the services the platform can connect to

The Account type list in the Add a connection form

4. Enter a Name that describes the account, such as Acme code repositories, and the Site address if the form asks for one

The Name and Site address fields

5. Enter the account's credentials. For an Atlassian account, enter the Account email and the API token; other services ask for what they need, such as an access token

The Account email and API token fields

6. Click Add and check. The platform saves the connection and checks it straight away

The Add and check button

Credentials are stored encrypted and are never shown again, even to administrators.

To replace a connection's credentials:

1. On the connection's card, expand Replace credentials

2. Enter the replacement credentials, then click Replace and check

To delete a connection:

Important: Delete connection is unavailable while a product uses the connection. To delete it, open Config, choose a different connection for each product that uses it, then come back to Connections and click Delete connection.