Skip to content
Start here

Triggers

List triggers by script
GET/accounts/{account_id}/builds/workers/{external_script_id}/triggers
Create trigger
POST/accounts/{account_id}/builds/triggers
Update trigger
PATCH/accounts/{account_id}/builds/triggers/{trigger_uuid}
Delete trigger
DELETE/accounts/{account_id}/builds/triggers/{trigger_uuid}
Purge build cache
POST/accounts/{account_id}/builds/triggers/{trigger_uuid}/purge_build_cache
Create manual build
POST/accounts/{account_id}/builds/triggers/{trigger_uuid}/builds
ModelsExpand Collapse
TriggerListResponse = object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string
branch_includes: optional array of string
build_caching_enabled: optional boolean
build_command: optional string
build_token_name: optional string
build_token_uuid: optional string

Build token UUID.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string
external_script_id: optional string

External script identifier.

modified_on: optional string
formatdate-time
path_excludes: optional array of string
path_includes: optional array of string
repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider account identifier.

provider_account_name: optional string
provider_type: optional "github"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Repository identifier.

repo_name: optional string
root_directory: optional string

Root directory path.

trigger_name: optional string
trigger_uuid: optional string

Trigger UUID.

formatuuid
TriggerCreateResponse = object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string
branch_includes: optional array of string
build_caching_enabled: optional boolean
build_command: optional string
build_token_name: optional string
build_token_uuid: optional string

Build token UUID.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string
external_script_id: optional string

External script identifier.

modified_on: optional string
formatdate-time
path_excludes: optional array of string
path_includes: optional array of string
repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider account identifier.

provider_account_name: optional string
provider_type: optional "github"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Repository identifier.

repo_name: optional string
root_directory: optional string

Root directory path.

trigger_name: optional string
trigger_uuid: optional string

Trigger UUID.

formatuuid
TriggerUpdateResponse = object { branch_excludes, branch_includes, build_caching_enabled, 14 more }
branch_excludes: optional array of string
branch_includes: optional array of string
build_caching_enabled: optional boolean
build_command: optional string
build_token_name: optional string
build_token_uuid: optional string

Build token UUID.

formatuuid
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
deploy_command: optional string
external_script_id: optional string

External script identifier.

modified_on: optional string
formatdate-time
path_excludes: optional array of string
path_includes: optional array of string
repo_connection: optional object { created_on, deleted_on, modified_on, 6 more }
created_on: optional string
formatdate-time
deleted_on: optional string
formatdate-time
modified_on: optional string
formatdate-time
provider_account_id: optional string

Provider account identifier.

provider_account_name: optional string
provider_type: optional "github"
repo_connection_uuid: optional string

Repository connection UUID.

formatuuid
repo_id: optional string

Repository identifier.

repo_name: optional string
root_directory: optional string

Root directory path.

trigger_name: optional string
trigger_uuid: optional string

Trigger UUID.

formatuuid
TriggerDeleteResponse = unknown
TriggerPurgeCacheResponse = unknown
TriggerCreateBuildResponse = object { build_uuid, created_on }
build_uuid: optional string

Build UUID.

formatuuid
created_on: optional string
formatdate-time

TriggersEnvironment Variables

List environment variables
GET/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables
Upsert environment variables
PATCH/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables
Delete environment variable
DELETE/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables/{environment_variable_key}
ModelsExpand Collapse
EnvironmentVariableListResponse = map[object { created_on, is_secret, value } ]
created_on: string
formatdate-time
is_secret: boolean
value: optional string

Value is null for secret environment variables

EnvironmentVariableUpsertResponse = map[object { created_on, is_secret, value } ]
created_on: string
formatdate-time
is_secret: boolean
value: optional string

Value is null for secret environment variables

EnvironmentVariableDeleteResponse = unknown