Skip to main content

Buildkite Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Buildkite location.
buildkite_api.png

Buildkite

  1. Click the + icon on the Nexset that will be sent to the Buildkite destination, and select the Send to Destination option from the menu.

  2. Select the Buildkite connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Buildkite organization, and click Next; or, create a new Buildkite credential for use in this flow.

  3. Buildkite destinations can be manually configured to send data to any valid Buildkite REST API endpoint. This allows you to trigger builds, create pipelines, update pipeline configurations, or push data to any writable Buildkite resource. You can also configure Nexla to automatically send the response received from the Buildkite API after each call to a new Nexla webhook data source.

    First, select the API method that will be used for calls to the Buildkite API from the Method pulldown menu.

    Common Buildkite write operations and their corresponding HTTP methods include:

    • POST: For triggering new builds, creating pipelines, or creating new resources
    • PUT: For fully replacing existing pipeline configurations or resource settings
    • PATCH: For partially updating pipeline configurations, settings, or other resources
    • DELETE: For removing pipelines, agents, or other resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Buildkite API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Buildkite REST API accepts and returns data in JSON format, so select JSON as the content format.

API Endpoint URL​

  1. Enter the URL of the Buildkite API endpoint to which you want to send the Nexset data in the URL field.

    Common Buildkite write endpoints include:

    • Trigger a new build: https://api.buildkite.com/v2/organizations/{'{org_slug}'}/pipelines/{'{pipeline_slug}'}/builds
    • Create a new pipeline: https://api.buildkite.com/v2/organizations/{'{org_slug}'}/pipelines
    • Update a pipeline: https://api.buildkite.com/v2/organizations/{'{org_slug}'}/pipelines/{'{pipeline_slug}'}
    • Create an annotation on a build: https://api.buildkite.com/v2/organizations/{'{org_slug}'}/pipelines/{'{pipeline_slug}'}/builds/{'{build_number}'}/annotations

    Replace {'{org_slug}'} with your Buildkite organization slug. For update and upsert operations, include the relevant identifier (such as the pipeline slug or build number) at the end of the URL.

The Buildkite REST API base URL is https://api.buildkite.com/v2. All requests must be made over HTTPS. For complete documentation on available endpoints and required request body parameters, see the Buildkite REST API reference.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header, as it is handled automatically by Nexla using the API key stored in your Buildkite credential. The Content-Type: application/json header is also managed automatically.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Buildkite destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings — click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field. For example, when triggering multiple Buildkite builds in a single request, you might use a property name such as builds.
  2. If any additional properties should be included in the request body alongside the batched records, enter those properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the Buildkite API after each call to a new Nexla webhook data source. This option allows you to track the status of each API call and capture any information returned by Buildkite — for example, the build number, state, and web URL of a newly triggered build.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Buildkite API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the Buildkite API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Buildkite API using the current settings.

Test Payload Caution

Sending a test payload to write endpoints (such as triggering a build) will create real resources in your Buildkite organization. Review the sample payload carefully before sending, and consider using a non-production pipeline or organization for initial testing.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Buildkite endpoint, open the destination resource menu and select Activate.

    The Nexset data will not be sent to the Buildkite API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.