Buildkite APIs

Authentication

The Buildkite REST and GraphQL APIs expect an access token to be provided using the Authorization HTTP header:

curl -H "Authorization: Bearer $TOKEN" https://api.buildkite.com/v2/user

Generate an Access Token.

All webhooks contain an X-Buildkite-Token header which allows you to verify the authenticity of the request.

REST API

The Buildkite REST API aims to give you complete programmatic access and control of Buildkite to extend, integrate and automate anything to suit your particular needs.

  1. Generate an API Access Token with as much scope as you need.
  2. Make requests to https://api.buildkite.com using the token you generated in the Authorization header:

    curl -H "Authorization: Bearer $TOKEN" https://api.buildkite.com/v2/user
    

More information about the REST API.

GraphQL

The Buildkite GraphQL API provides an alternative to the REST API. It allows for more efficient retrieval of data by enabling you to fetch multiple, nested resources in a single request.

  1. Generate an API Access Token with GraphQL scope
  2. Open the GraphQL Explorer
  3. Follow the GraphQL Tutorial

More information about the GraphQL API.

Webhooks

Webhooks allow you to monitor and respond to events within your Buildkite organization, providing a real time view of activity and allowing you to extend and integrate Buildkite into your systems.

Webhooks can be added and configured on your organization's Notification Services settings page.

More information about the webhooks.