Buildkite

Prerequisites

• An active Buildkite account from which data is to be ingested exists.

• The API credentials are available to authenticate Hevo on your Buildkite account.

• You must be logged in as an Admin user to access all the data.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

---

Obtaining the API Credentials

Hevo uses an access token and organization slug to authenticate itself on your Buildkite account. These credentials do not expire and can be reused for all your Pipelines.

Note: You must log in as an Admin user to perform these steps.

Obtaining the access token

Perform the following steps to obtain your access token:

1. Log in to your Buildkite account.

2. Click on your user name in the top right corner, and select Personal Settings.

   

3. In the left navigation pane, in the Personal Settings section, select API Access Tokens.

   

4. In the API Access Tokens page, click New API Access Token.

   

5. In the New API Access Token page, specify the following:

   

   • Description: A unique name for your access token.

   • Organization Access: The organization from where you want to ingest data.

   • REST API Scopes: The API permissions needed by Hevo to access your data. Hevo only needs read access to your API resources to ingest data. Select the following scopes:

     • Read Agents

     • Read Teams

     • Read Artifacts

     • Read Builds

     • Read Job Environment Variables

     • Read Build Logs

     • Read Organizations

     • Read Pipelines

     • Read User

     • Read Flaky Tests

6. Click Create New API Access Token.

7. Copy the access token, and save it securely like any other password. Use this token while configuring your Hevo Pipeline.

   

Obtaining the organization slug

An organization slug is a unique identifier for an organization in your Buildkite account. It can be found in the URL, appearing after the main Buildkite domain, and forms part of the URL structure. For example, in the URL https://buildkite.com/my-organization/my-project, the organization slug is my-organization.

Perform the following steps to obtain the organization slug:

1. Log in to your Buildkite account.

2. Click on your username in the top right corner, and select Personal Settings.

   

3. In the left navigation pane, Organization Settings section, select the organization from where you want to ingest data.

   

4. In the Organization Settings page, copy the Slug, and save it securely like any other password. Use this slug while configuring your Hevo Pipeline.

   

---

Configuring Buildkite as a Source

Perform the following steps to configure Buildkite as the Source in your Pipeline:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE in the Pipelines List View.

3. In the Select Source Type page, select Buildkite.

4. In the Configure your Buildkite Source page, specify the following:

   

   • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

   • Access Token: The token that you obtained from your Buildkite account.

   • Organization slug: The unique identifier that you obtained from your Buildkite account to identify the organization from where you want to ingest data.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.

---