Buildkite integration guide
VerifiedHow to connect Buildkite to WEXTL and use its 2 triggers and 148 actions in your workflows. About Buildkite: Continuous integration and delivery platform for running fast, secure pipelines.
- 2 triggers
- 70 searches
- 78 actions
- Instant (webhooks)
- Auth: API key
AI-assisted documentation41 min read
This documentation is compiled from our integration source code, internal specs for Buildkite, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Buildkite credentials
- API Access TokenpasswordRequired
Create it at buildkite.com/user/api-access-tokens. Tick the scopes your workflow needs: read_builds and write_builds, read_pipelines and write_pipelines, read_agents and write_agents, read_clusters and write_clusters, read_teams and write_teams, read_suites and write_suites, read_secrets_details, read_audit_events. Watch Events needs write_notification_services and an organization administrator as the token owner.[1]
- Organization SlugtextRequired
The part after buildkite.com/ in your URL, not the whole URL. Every action uses it, and an action can override it.[1]
Connect Buildkite in WEXTL
- Log in to your WEXTL account, add the Buildkite node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Buildkite account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Buildkite triggers and actions on WEXTL
The list below is a reference of every Buildkite node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Buildkite node module below to inspect its input parameters, outputs, and connection requirements.
Watch Builds
TriggerPolls for builds as they are created.
| Field | Type |
|---|---|
LimitRequired | number |
| Pipeline | choice |
| Branches | text |
| State | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Number | number |
| State | text |
| Web url | text |
| Branch | text |
| Commit | text |
| Message | text |
| Source | text |
1other output field
Watch Events
TriggerStarts on Buildkite webhook events.
| Field | Type |
|---|---|
| Event | text |
| Build | object |
| ID | text |
| Number | number |
| State | text |
| Branch | text |
| Commit | text |
| Message | text |
| Web url | text |
| Pipeline slug | text |
| Job | object |
| ID | text |
| Name | text |
| State | text |
| Exit status | number |
| Agent | object |
| ID | text |
| Name | text |
| Connection state | text |
| Pipeline | object |
| ID | text |
| Name | text |
| Slug | text |
| Sender | object |
| ID | text |
| Name | text |
Find a Test
SearchFinds a test by scope and name.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
ScopeRequired | text |
NameRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
Get a Build
SearchBuild details with optional jobs and test data.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
| Include Jobs | boolean |
| Include Test Engine Data | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
Get a Cluster
SearchCluster details with its default queue.
| Field | Type |
|---|---|
ClusterRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Default queue id | text |
| Name | text |
| Description | text |
| Emoji | text |
| Color | text |
| URL | text |
4other output fields
Get a Cluster Maintainer
SearchWho maintains a cluster and in what capacity.
| Field | Type |
|---|---|
ClusterRequired | choice |
Maintainer IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Actor id | text |
| Actor type | text |
| URL | text |
| Cluster url | text |
| Actor | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Get a Cluster Secret
SearchMetadata of a stored cluster secret.
| Field | Type |
|---|---|
ClusterRequired | choice |
Secret IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| Policy | text |
| Created at | date |
| Updated at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
3other output fields
Get a Job
SearchSingle build job details.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Type | text |
| Name | text |
| Step key | text |
| State | text |
| Web url | text |
| Command | text |
7other output fields
Get a Job Log
SearchConsole output produced by a job.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| URL | text |
| Content | text |
| Size | number |
| Header times | array |
Get a Member
SearchMember profile in the organization.
| Field | Type |
|---|---|
MemberRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| Sso mode | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Get a Pipeline
SearchPipeline summary with its links.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
12other output fields
Get a Pipeline Schedule
SearchCron timing of a schedule.
| Field | Type |
|---|---|
PipelineRequired | choice |
Schedule IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Label | text |
| Cronline | text |
| Branch | text |
| Commit | text |
| Message | text |
5other output fields
Get a Pipeline Template
SearchTemplate metadata and its YAML.
| Field | Type |
|---|---|
Template IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Name | text |
| Description | text |
| Configuration | text |
| Available | boolean |
| URL | text |
| Created at | date |
1other output field
Get a Pipeline Trigger
SearchSettings of an incoming pipeline trigger.
| Field | Type |
|---|---|
PipelineRequired | choice |
Trigger IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Enabled | boolean |
| URL | text |
| Type | text |
| Build | object |
| Branch | text |
| Filter | object |
| Created at | date |
1other output field
Get a Queue
SearchSettings of an agent queue in a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
QueueRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
Get a Rule
SearchDefinition of one organization rule.
| Field | Type |
|---|---|
Rule IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Value | object |
| Source pipeline | text |
| Target pipeline | text |
| Created at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Get a Team
SearchTeam summary with links.
| Field | Type |
|---|---|
TeamRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Slug | text |
| Description | text |
| Privacy | text |
4other output fields
Get a Team Member
SearchRole of a member within a team.
| Field | Type |
|---|---|
TeamRequired | choice |
MemberRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| URL | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Get a Team Pipeline
SearchTeam permission level on a pipeline.
| Field | Type |
|---|---|
TeamRequired | choice |
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Pipeline | object |
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
| Cluster id | text |
| Default branch | text |
Get a Team Suite
SearchTeam permission on a test suite.
| Field | Type |
|---|---|
TeamRequired | choice |
Test Suite IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Suite | object |
| ID | text |
| Slug | text |
| Name | text |
Get a Test
SearchTest details with execution history.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
Test IDRequired | text |
| Period | text |
| Minimum Timestamp | date |
| Maximum Timestamp | date |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
Get a Test Run
SearchBranch and commit of a suite run.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
Run IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Branch | text |
| Commit sha | text |
| Result | text |
| State | text |
| Created at | date |
1other output field
Get a Test Suite
SearchTest suite slug and web address.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Slug | text |
| Name | text |
| URL | text |
| Web url | text |
| Default branch | text |
Get a Trigger Delivery
SearchOutcome of one trigger delivery request.
| Field | Type |
|---|---|
PipelineRequired | choice |
Trigger IDRequired | text |
Delivery IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Status | text |
| Created at | date |
| Build id | text |
| Request method | text |
Get a Trigger Delivery Request
SearchRaw request behind a trigger delivery.
| Field | Type |
|---|---|
PipelineRequired | choice |
Trigger IDRequired | text |
Delivery IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Method | text |
| Headers | object |
| Content type | text |
| Body | text |
Get an Agent
SearchAgent record with its name and links.
| Field | Type |
|---|---|
AgentRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Connection state | text |
| Hostname | text |
| Ip address | text |
8other output fields
Get an Agent Token
SearchSettings of a cluster registration token.
| Field | Type |
|---|---|
ClusterRequired | choice |
Agent Token IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Description | text |
| Allowed ip addresses | text |
| Allow all queues | boolean |
| Allowed queue ids | array |
| Expires at | text |
| URL | text |
3other output fields
Get an Artifact
SearchDetails about a stored job artifact file.
| Field | Type |
|---|---|
Job IDRequired | text |
Artifact IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Job id | text |
| URL | text |
| Download url | text |
| State | text |
| Path | text |
| Dirname | text |
| Filename | text |
5other output fields
Get an Artifact Download Link
SearchURL for fetching an artifact file.
| Field | Type |
|---|---|
Job IDRequired | text |
Artifact IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| URL | text |
Get an Audit Event
SearchWho did what, and when, in an audit log entry.
| Field | Type |
|---|---|
Audit Event IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Occurred at | date |
| Type | text |
| Description | text |
| Actor | object |
| Type | text |
| Name | text |
| Subject | object |
| Type | text |
| Name | text |
| Data | object |
Get an Invitation
SearchDetails of an organization invitation.
| Field | Type |
|---|---|
Invitation IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| State | text |
| text | |
| Role | text |
| Created at | date |
| Invited by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Get an Organization
SearchOrganization name and its links.
| Field | Type |
|---|---|
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Slug | text |
| Agents url | text |
| Emojis url | text |
2other output fields
Get Failed Executions
SearchFailures recorded in a test run.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
Run IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Run id | text |
| Failed executions | array |
| Failed execution | object |
Get the Current Token
SearchScopes and description of the token in use.
| Field | Type |
|---|---|
| Uuid | text |
| Scopes | array |
| Description | text |
| Created at | date |
| User | object |
| Name | text |
| text |
Get the Current User
SearchThe signed-in Buildkite user.
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Get the Job Concurrency
SearchConcurrency group limits for a job.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Group | text |
| Limit | number |
| Running | number |
Get the Job Environment Variables
SearchVariables a job received at run time.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Env | object |
| CI | text |
| BUILDKITE | text |
Get the Rate Limits
SearchRemaining API allowance for the organization.
| Field | Type |
|---|---|
| Organization | choice |
| Field | Type |
|---|---|
| Rest | object |
| Limit | number |
| Remaining | number |
| Reset | number |
| Graphql | object |
| Limit | number |
| Remaining | number |
| Reset | number |
List Agent Tokens
SearchRegistration tokens issued for a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Description | text |
| Allowed ip addresses | text |
| Allow all queues | boolean |
| Allowed queue ids | array |
| Expires at | text |
| URL | text |
3other output fields
List Agents
SearchAgents with their connection state.
| Field | Type |
|---|---|
LimitRequired | number |
| Name | text |
| Hostname | text |
| Version | text |
| Queue ID | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Connection state | text |
| Hostname | text |
| Ip address | text |
8other output fields
List All Builds
SearchBuilds across all your organizations.
| Field | Type |
|---|---|
LimitRequired | number |
| Branches | text |
| State | choice |
| Commit | text |
| Creator | text |
| Created From | date |
| Created To | date |
| Finished From | date |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
List Audit Events
SearchAudit trail of organization activity.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Occurred at | date |
| Type | text |
| Description | text |
| Actor | object |
| Type | text |
| Name | text |
| Subject | object |
| Type | text |
| Name | text |
| Data | object |
List Build Annotations
SearchNotes attached to a build page.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
LimitRequired | number |
| Scope | text |
| Body Format | choice |
| Omit Body | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Context | text |
| Style | text |
| Body html | text |
| Created at | date |
| Updated at | date |
List Build Artifacts
SearchFiles uploaded during a build.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
LimitRequired | number |
| State | text |
| Path | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Job id | text |
| URL | text |
| Download url | text |
| State | text |
| Path | text |
| Dirname | text |
| Filename | text |
5other output fields
List Build Tests
SearchTest Engine tests that ran in a build.
| Field | Type |
|---|---|
Build IDRequired | text |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
List Cluster Maintainers
SearchPeople and teams maintaining a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Actor id | text |
| Actor type | text |
| URL | text |
| Cluster url | text |
| Actor | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
List Cluster Secrets
SearchNames and settings of secrets kept with a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| Policy | text |
| Created at | date |
| Updated at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
3other output fields
List Clusters
SearchAgent clusters in the organization.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Default queue id | text |
| Name | text |
| Description | text |
| Emoji | text |
| Color | text |
| URL | text |
4other output fields
List Invitations
SearchInvitations to the organization with their State and Role.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| State | text |
| text | |
| Role | text |
| Created at | date |
| Invited by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
List Job Annotations
SearchNotes attached to a job.
| Field | Type |
|---|---|
Job IDRequired | text |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Context | text |
| Style | text |
| Body html | text |
| Created at | date |
| Updated at | date |
List Job Artifacts
SearchArtifact files uploaded by a single job.
| Field | Type |
|---|---|
Job IDRequired | text |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Job id | text |
| URL | text |
| Download url | text |
| State | text |
| Path | text |
| Dirname | text |
| Filename | text |
5other output fields
List Jobs
SearchJobs belonging to a build.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
LimitRequired | number |
| State | choice |
| Step Key | text |
| Group Key | text |
| Include Retried Jobs | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Type | text |
| Name | text |
| Step key | text |
| State | text |
| Web url | text |
| Command | text |
7other output fields
List Members
SearchOrganization member roster with roles.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| Sso mode | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
List Muted Tests
SearchTests currently muted in a suite.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
List Organization Builds
SearchBuilds run across one organization.
| Field | Type |
|---|---|
LimitRequired | number |
| Branches | text |
| State | choice |
| Commit | text |
| Creator | text |
| Created From | date |
| Created To | date |
| Finished From | date |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
List Organizations
SearchBuildkite organizations you can reach.
| Field | Type |
|---|---|
LimitRequired | number |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Slug | text |
| Agents url | text |
| Emojis url | text |
2other output fields
List Pipeline Builds
SearchBuilds of one pipeline, filterable by branch or state.
| Field | Type |
|---|---|
PipelineRequired | choice |
LimitRequired | number |
| Branches | text |
| State | choice |
| Commit | text |
| Creator | text |
| Created From | date |
| Created To | date |
5other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
List Pipeline Schedules
SearchRecurring builds planned for a pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Label | text |
| Cronline | text |
| Branch | text |
| Commit | text |
| Message | text |
5other output fields
List Pipeline Templates
SearchPipeline templates written in YAML.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Name | text |
| Description | text |
| Configuration | text |
| Available | boolean |
| URL | text |
| Created at | date |
1other output field
List Pipeline Test Suites
SearchSuites receiving test results from a pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Slug | text |
| Name | text |
| URL | text |
| Web url | text |
| Default branch | text |
List Pipeline Triggers
SearchIncoming triggers set up on a pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Enabled | boolean |
| URL | text |
| Type | text |
| Build | object |
| Branch | text |
| Filter | object |
| Created at | date |
1other output field
List Pipelines
SearchPipelines that build your repositories.
| Field | Type |
|---|---|
LimitRequired | number |
| Name | text |
| Repository | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
12other output fields
List Queues
SearchQueues in a cluster, each with its Key and URL.
| Field | Type |
|---|---|
ClusterRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
List Rules
SearchRules set up for the organization.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Value | object |
| Source pipeline | text |
| Target pipeline | text |
| Created at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
List Team Members
SearchMembership roster of one team.
| Field | Type |
|---|---|
TeamRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| URL | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
List Team Pipelines
SearchPipelines open to a team, with access levels.
| Field | Type |
|---|---|
TeamRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Pipeline | object |
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
| Cluster id | text |
| Default branch | text |
List Team Suites
SearchTest suites open to a team, with access levels.
| Field | Type |
|---|---|
TeamRequired | choice |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Suite | object |
| ID | text |
| Slug | text |
| Name | text |
List Teams
SearchTeams defined for the organization.
| Field | Type |
|---|---|
LimitRequired | number |
| User ID | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Slug | text |
| Description | text |
| Privacy | text |
4other output fields
List Test Runs
SearchRun history recorded for a suite.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
LimitRequired | number |
| Build ID | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Branch | text |
| Commit sha | text |
| Result | text |
| State | text |
| Created at | date |
1other output field
List Test Suites
SearchTest Engine suites in the organization.
| Field | Type |
|---|---|
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Slug | text |
| Name | text |
| URL | text |
| Web url | text |
| Default branch | text |
List Tests
SearchTests recorded for a suite.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
LimitRequired | number |
| State | text |
| Labels | text |
| Branch | text |
| Owners | text |
| Tags | text |
| Minimum Executions | number |
6other input fields
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
List Trigger Deliveries
SearchCalls handled by a trigger.
| Field | Type |
|---|---|
PipelineRequired | choice |
Trigger IDRequired | text |
LimitRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Status | text |
| Created at | date |
| Build id | text |
| Request method | text |
Add a Cluster Maintainer
ActionGrants cluster maintenance rights.
| Field | Type |
|---|---|
ClusterRequired | choice |
Maintainer TypeRequired | choice |
User or Team IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Actor id | text |
| Actor type | text |
| URL | text |
| Cluster url | text |
| Actor | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Add a Pipeline Webhook
ActionSets up the repository webhook for a pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Pipeline | text |
Add a Team Member
ActionEnrolls an organization member in a team with a role.
| Field | Type |
|---|---|
TeamRequired | choice |
MemberRequired | choice |
RoleRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| URL | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Add a Team Pipeline
ActionGrants a team rights on a pipeline.
| Field | Type |
|---|---|
TeamRequired | choice |
PipelineRequired | choice |
Access LevelRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Pipeline | object |
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
| Cluster id | text |
| Default branch | text |
Add a Team Suite
ActionGives one team a test suite to use.
| Field | Type |
|---|---|
TeamRequired | choice |
Test Suite IDRequired | text |
Access LevelRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Suite | object |
| ID | text |
| Slug | text |
| Name | text |
Archive a Pipeline
ActionMoves a pipeline into the archived state.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Pipeline | text |
Cancel a Build
ActionHalts one build and reports its State.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
Cancel a Job
ActionStops a single job in a build.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Type | text |
| Name | text |
| Step key | text |
| State | text |
| Web url | text |
| Command | text |
7other output fields
Create a Build
ActionStarts a pipeline run.
| Field | Type |
|---|---|
PipelineRequired | choice |
CommitRequired | text |
BranchRequired | text |
| Message | text |
| Author Name | text |
| Author Email | text |
| Environment Variables | array |
| Variable | object |
| Meta Data | array |
| Entry | object |
7other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
Create a Build Annotation
ActionPosts a note on a build page.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
BodyRequired | text |
| Style | choice |
| Context | text |
| Priority | number |
| Append | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Context | text |
| Style | text |
| Body html | text |
| Created at | date |
| Updated at | date |
Create a Cluster
ActionCreates a cluster for agents and queues.
| Field | Type |
|---|---|
NameRequired | text |
| Description | text |
| Emoji | text |
| Color | text |
| Maintainers (JSON) | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Default queue id | text |
| Name | text |
| Description | text |
| Emoji | text |
| Color | text |
| URL | text |
4other output fields
Create a Cluster Secret
ActionKeeps a secret value with a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
KeyRequired | text |
ValueRequired | secret |
| Description | text |
| Policy | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| Policy | text |
| Created at | date |
| Updated at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
3other output fields
Create a Hosted Queue
ActionCreates a queue backed by hosted agents.
| Field | Type |
|---|---|
ClusterRequired | choice |
KeyRequired | text |
Instance ShapeRequired | choice |
| Description | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
Create a Job Annotation
ActionPosts a note on a job.
| Field | Type |
|---|---|
Job IDRequired | text |
BodyRequired | text |
| Style | choice |
| Context | text |
| Priority | number |
| Append | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Context | text |
| Style | text |
| Body html | text |
| Created at | date |
| Updated at | date |
Create a Pipeline
ActionRegisters a new pipeline with its YAML steps.
| Field | Type |
|---|---|
NameRequired | text |
RepositoryRequired | text |
Configuration (YAML)Required | text |
| Slug | text |
| Description | text |
| Cluster | choice |
| Default Branch | text |
| Branch Filter | text |
15other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
12other output fields
Create a Pipeline Schedule
ActionRuns builds on a cron line.
| Field | Type |
|---|---|
PipelineRequired | choice |
Cron LineRequired | text |
LabelRequired | text |
| Branch | text |
| Commit | text |
| Message | text |
| Environment Variables | array |
| Variable | object |
| Enabled | boolean |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Label | text |
| Cronline | text |
| Branch | text |
| Commit | text |
| Message | text |
5other output fields
Create a Pipeline Template
ActionStores YAML steps as a pipeline template.
| Field | Type |
|---|---|
NameRequired | text |
Configuration (YAML)Required | text |
| Description | text |
| Available | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Name | text |
| Description | text |
| Configuration | text |
| Available | boolean |
| URL | text |
| Created at | date |
1other output field
Create a Pipeline Trigger
ActionSets up what starts builds through a pipeline trigger.
| Field | Type |
|---|---|
PipelineRequired | choice |
LabelRequired | text |
TypeRequired | choice |
| Enabled | boolean |
| Build (JSON) | text |
| Filter (JSON) | text |
| Verification (JSON) | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Enabled | boolean |
| URL | text |
| Endpoint url | text |
| Type | text |
| Build | object |
| Branch | text |
| Filter | object |
2other output fields
Create a Rule
ActionAdds an organization rule.
| Field | Type |
|---|---|
TypeRequired | text |
Value (JSON)Required | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Value | object |
| Source pipeline | text |
| Target pipeline | text |
| Created at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Create a Self-Hosted Queue
ActionCreates a queue for your own agents.
| Field | Type |
|---|---|
ClusterRequired | choice |
KeyRequired | text |
| Description | text |
| Use GitHub App Token | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
Create a Team
ActionOpens a new team for the organization.
| Field | Type |
|---|---|
NameRequired | text |
| Description | text |
| Privacy | choice |
| Default Team | boolean |
| Default Member Role | choice |
| Members Can Create Pipelines | boolean |
| Members Can Create Test Suites | boolean |
| Members Can Create Registries | boolean |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Slug | text |
| Description | text |
| Privacy | text |
4other output fields
Create a Test Suite
ActionOpens a Test Engine suite for your tests.
| Field | Type |
|---|---|
NameRequired | text |
| Default Branch | text |
| Team IDs | text |
| Application Name | text |
| Repository URL | text |
| Color | text |
| Emoji | text |
| Show API Token | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Slug | text |
| Name | text |
| URL | text |
| Web url | text |
| Default branch | text |
| API Token | text |
Create an Agent Token
ActionIssues an agent registration token for a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
| Description | text |
| Expires At | date |
| Allowed IP Addresses | text |
| Allow All Queues | boolean |
| Allowed Queue IDs | text |
| Permissions | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Description | text |
| Allowed ip addresses | text |
| Allow all queues | boolean |
| Allowed queue ids | array |
| Expires at | text |
| URL | text |
4other output fields
Create Invitations
ActionInvites people to the organization.
| Field | Type |
|---|---|
EmailsRequired | text |
| Role | choice |
| SSO Mode | choice |
| Teams | array |
| Team | object |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| State | text |
| text | |
| Role | text |
| Created at | date |
| Invited by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Delete a Build Annotation
ActionDeletes one note from a build page.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
Annotation IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Cluster
ActionDeletes a Buildkite cluster of agents and queues.
| Field | Type |
|---|---|
ClusterRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Cluster Secret
ActionDeletes one key and value pair from a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
Secret IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Job Annotation
ActionRemoves a note from a job.
| Field | Type |
|---|---|
Job IDRequired | text |
Annotation IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Job Log
ActionDeletes the recorded output of a job.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Pipeline
ActionPipeline removal from the Buildkite organization.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Pipeline Schedule
ActionDeletes one scheduled build rule.
| Field | Type |
|---|---|
PipelineRequired | choice |
Schedule IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Pipeline Template
ActionRemoves one YAML pipeline template.
| Field | Type |
|---|---|
Template IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Pipeline Trigger
ActionDeletes one trigger that starts builds from outside calls.
| Field | Type |
|---|---|
PipelineRequired | choice |
Trigger IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Queue
ActionRemoves one agent queue.
| Field | Type |
|---|---|
ClusterRequired | choice |
QueueRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Rule
ActionRemoves a single organization rule.
| Field | Type |
|---|---|
Rule IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Team
ActionDeletes one Buildkite team of the organization.
| Field | Type |
|---|---|
TeamRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete a Test Suite
ActionRemoves a suite of tests from Test Engine.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Delete an Artifact
ActionRemoves one uploaded job artifact.
| Field | Type |
|---|---|
Job IDRequired | text |
Artifact IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Disable the GitHub Webhook Processing
ActionStops GitHub webhook handling for a pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Pipeline | text |
Enable a Test
ActionReactivates a muted or skipped test.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
Test IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
Enable the GitHub Webhook Processing
ActionTurns GitHub webhook handling on for a pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Pipeline | text |
Make an API Call
universalYour own Buildkite REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Content-Type | text |
| Status code | number |
Mute a Test
ActionMarks a test as muted in its suite.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
Test IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
Pause a Queue
ActionHalts job pickup on a cluster queue.
| Field | Type |
|---|---|
ClusterRequired | choice |
QueueRequired | choice |
| Note | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
Pause an Agent
ActionPauses an agent, optionally for a set time.
| Field | Type |
|---|---|
AgentRequired | choice |
| Note | text |
| Timeout (minutes) | number |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Agent | text |
Rebuild a Build
ActionReruns an earlier build.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
Remove a Cluster Maintainer
ActionRevokes maintainer rights on a cluster.
| Field | Type |
|---|---|
ClusterRequired | choice |
Maintainer IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Remove a Member
ActionRevokes the organization membership of one person.
| Field | Type |
|---|---|
MemberRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Remove a Team Member
ActionEnds the membership of a person in a team.
| Field | Type |
|---|---|
TeamRequired | choice |
MemberRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Remove a Team Pipeline
ActionSevers the link between a team and a pipeline.
| Field | Type |
|---|---|
TeamRequired | choice |
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Remove a Team Suite
ActionEnds team access to a test suite.
| Field | Type |
|---|---|
TeamRequired | choice |
Test Suite IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Reprioritize a Job
ActionChanges how soon a job gets an agent.
| Field | Type |
|---|---|
Job IDRequired | text |
PriorityRequired | number |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Type | text |
| Name | text |
| Step key | text |
| State | text |
| Web url | text |
| Command | text |
7other output fields
Resume a Queue
ActionLets agents run jobs from a queue again.
| Field | Type |
|---|---|
ClusterRequired | choice |
QueueRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
Resume an Agent
ActionResumes work on a paused agent.
| Field | Type |
|---|---|
AgentRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Agent | text |
Retry a Job
ActionReruns a single job from a build.
| Field | Type |
|---|---|
Job IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Type | text |
| Name | text |
| Step key | text |
| State | text |
| Web url | text |
| Command | text |
7other output fields
Retry Failed Jobs
ActionRetries failed jobs across one build.
| Field | Type |
|---|---|
PipelineRequired | choice |
Build NumberRequired | text |
| States | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Number | number |
| State | text |
| Blocked | boolean |
| Message | text |
12other output fields
Revoke an Agent Token
ActionInvalidates a registration token for agents.
| Field | Type |
|---|---|
ClusterRequired | choice |
Agent Token IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Revoke an Invitation
ActionWithdraws an invitation to the organization.
| Field | Type |
|---|---|
Invitation IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
Skip a Test
ActionFlags a test to be skipped.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
Test IDRequired | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| URL | text |
| Web url | text |
| Scope | text |
| Name | text |
| Location | text |
| File name | text |
| Labels | array |
Stop an Agent
ActionStops an agent, optionally at once.
| Field | Type |
|---|---|
AgentRequired | choice |
| Force | boolean |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Agent | text |
Unarchive a Pipeline
ActionRestores an archived pipeline.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| Success | boolean |
| Pipeline | text |
Unblock a Job
ActionReleases a job held by a manual step.
| Field | Type |
|---|---|
Job IDRequired | text |
| Unblocker | text |
| Fields | array |
| Field | object |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Type | text |
| Name | text |
| Step key | text |
| State | text |
| Web url | text |
| Command | text |
7other output fields
Update a Cluster
ActionEdits cluster name, look and default queue.
| Field | Type |
|---|---|
ClusterRequired | choice |
| Name | text |
| Description | text |
| Emoji | text |
| Color | text |
| Default Queue ID | text |
| Hosted Agents | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Default queue id | text |
| Name | text |
| Description | text |
| Emoji | text |
| Color | text |
| URL | text |
4other output fields
Update a Member
ActionEdits role and sign-on mode of a member.
| Field | Type |
|---|---|
MemberRequired | choice |
| Role | choice |
| SSO Mode | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| Sso mode | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Update a Pipeline
ActionEdits pipeline name, source and branches.
| Field | Type |
|---|---|
PipelineRequired | choice |
| Name | text |
| Repository | text |
| Configuration (YAML) | text |
| Slug | text |
| Environment Variables | array |
| Variable | object |
| Description | text |
| Cluster | choice |
18other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
12other output fields
Update a Pipeline Schedule
ActionEdits timing and target of a schedule.
| Field | Type |
|---|---|
PipelineRequired | choice |
Schedule IDRequired | text |
| Cron Line | text |
| Label | text |
| Branch | text |
| Commit | text |
| Message | text |
| Environment Variables | array |
| Variable | object |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Label | text |
| Cronline | text |
| Branch | text |
| Commit | text |
| Message | text |
5other output fields
Update a Pipeline Template
ActionEdits the YAML and text of a template.
| Field | Type |
|---|---|
Template IDRequired | text |
| Name | text |
| Description | text |
| Configuration (YAML) | text |
| Available | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Name | text |
| Description | text |
| Configuration | text |
| Available | boolean |
| URL | text |
| Created at | date |
1other output field
Update a Pipeline Trigger
ActionEdits what an incoming trigger builds.
| Field | Type |
|---|---|
PipelineRequired | choice |
Trigger IDRequired | text |
| Label | text |
| Enabled | choice |
| Build (JSON) | text |
| Filter (JSON) | text |
| Verification (JSON) | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Label | text |
| Enabled | boolean |
| URL | text |
| Type | text |
| Build | object |
| Branch | text |
| Filter | object |
| Created at | date |
1other output field
Update a Queue
ActionChanges the description and GitHub App token setting of a queue.
| Field | Type |
|---|---|
ClusterRequired | choice |
QueueRequired | choice |
| Description | text |
| Use GitHub App Token | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| URL | text |
| Web url | text |
| Cluster url | text |
| Dispatch paused | boolean |
6other output fields
Update a Secret Value
ActionOverwrites the value held by a cluster secret.
| Field | Type |
|---|---|
ClusterRequired | choice |
Secret IDRequired | text |
ValueRequired | secret |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| Policy | text |
| Created at | date |
| Updated at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
3other output fields
Update a Team
ActionEdits team name, privacy and member defaults.
| Field | Type |
|---|---|
TeamRequired | choice |
| Name | text |
| Description | text |
| Privacy | choice |
| Default Team | choice |
| Default Member Role | choice |
| Members Can Create Pipelines | choice |
| Members Can Create Test Suites | choice |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Slug | text |
| Description | text |
| Privacy | text |
4other output fields
Update a Team Member
ActionChanges the role held in a team.
| Field | Type |
|---|---|
TeamRequired | choice |
MemberRequired | choice |
RoleRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Role | text |
| URL | text |
| Created at | date |
| User | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
Update a Team Pipeline
ActionEdits how much a team can do on a pipeline.
| Field | Type |
|---|---|
TeamRequired | choice |
PipelineRequired | choice |
Access LevelRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Pipeline | object |
| ID | text |
| Graphql id | text |
| URL | text |
| Web url | text |
| Name | text |
| Description | text |
| Slug | text |
| Repository | text |
| Cluster id | text |
| Default branch | text |
Update a Team Suite
ActionEdits how much a team can do in a suite.
| Field | Type |
|---|---|
TeamRequired | choice |
Test Suite IDRequired | text |
Access LevelRequired | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Access level | text |
| URL | text |
| Created at | date |
| Suite | object |
| ID | text |
| Slug | text |
| Name | text |
Update a Test Suite
ActionEdits suite name, branch and appearance.
| Field | Type |
|---|---|
Test SuiteRequired | choice |
| Name | text |
| Default Branch | text |
| Application Name | text |
| Repository URL | text |
| Color | text |
| Emoji | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Slug | text |
| Name | text |
| URL | text |
| Web url | text |
| Default branch | text |
Update an Agent Token
ActionEdits the description and IP limits of a token.
| Field | Type |
|---|---|
ClusterRequired | choice |
Agent Token IDRequired | text |
| Description | text |
| Allowed IP Addresses | text |
| Allow All Queues | choice |
| Allowed Queue IDs | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Description | text |
| Allowed ip addresses | text |
| Allow all queues | boolean |
| Allowed queue ids | array |
| Expires at | text |
| URL | text |
3other output fields
Update Secret Settings
ActionEdits secret description and policy.
| Field | Type |
|---|---|
ClusterRequired | choice |
Secret IDRequired | text |
| Description | text |
| Policy | text |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Graphql id | text |
| Key | text |
| Description | text |
| Policy | text |
| Created at | date |
| Updated at | date |
| Created by | object |
| ID | text |
| Graphql id | text |
| Name | text |
| text | |
| Avatar url | text |
| Created at | date |
3other output fields
Templates
Look for Buildkite templates in the WEXTL template library.
Browse templates →Other developer tool integrations on WEXTL
API Verve[2]One key for hundreds of utility APIs: validate emails and phones, look up domains, IPs and companies, convert files and text, and more.
CircleCITrigger and inspect CircleCI pipelines and workflows, manage projects and contexts, and configure schedules and webhooks.
Better StackUptime monitoring, incident management and status pages.
AlchemyBlockchain data and node APIs: balances, NFTs, prices, transfers, webhooks and JSON-RPC.
ApifyRun Apify Actors and tasks, manage datasets and stores, and watch for Actor run completion events.
References
- WEXTL® Buildkite Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Buildkite.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 17:45
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.





























