--- title: Triggers --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Workers Builds](https://developers.cloudflare.com/api/resources/workers_builds) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Triggers ##### [List triggers for a Worker](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/methods/list) GET/accounts/{account\_id}/builds/workers/{external\_script\_id}/triggers ##### [Create a build trigger](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/methods/create) POST/accounts/{account\_id}/builds/triggers ##### [Update a build trigger](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/methods/update) PATCH/accounts/{account\_id}/builds/triggers/{trigger\_uuid} ##### [Delete a build trigger](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/methods/delete) DELETE/accounts/{account\_id}/builds/triggers/{trigger\_uuid} ##### [Purge a trigger's build cache](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/methods/purge_cache) POST/accounts/{account\_id}/builds/triggers/{trigger\_uuid}/purge\_build\_cache ##### [Start a Workers build](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/methods/create_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 patterns that must not start builds. Link to this property branch\_includes: optional array of string Branch patterns that can start builds. Link to this property build\_caching\_enabled: optional boolean Whether builds reuse cached dependencies and build artifacts. Link to this property build\_command: optional string Command to build the Worker. Link to this property build\_token\_name: optional string Link to this property build\_token\_uuid: optional string UUID of the build token used when deploying the Worker. formatuuid Link to this property created\_on: optional string formatdate-time Link to this property deleted\_on: optional string formatdate-time Link to this property deploy\_command: optional string Command to deploy the Worker. Link to this property external\_script\_id: optional string System-generated tag of the Worker. This is not the Worker name. Link to this property modified\_on: optional string formatdate-time Link to this property path\_excludes: optional array of string Path patterns that must not start builds. Link to this property path\_includes: optional array of string Path patterns that can start builds. Link to this property

repo\_connection: optional object {created\_on, deleted\_on, modified\_on, 6 more }

created\_on: optional string formatdate-time Link to this property deleted\_on: optional string formatdate-time Link to this property modified\_on: optional string formatdate-time Link to this property provider\_account\_id: optional string Provider-specific identifier of the account or namespace that owns the repository. Link to this property provider\_account\_name: optional string Human-readable name of the account or namespace that owns the repository. Link to this property

provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider.

One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property

Link to this property repo\_connection\_uuid: optional string Repository connection UUID. formatuuid Link to this property repo\_id: optional string Provider-specific repository identifier. Link to this property repo\_name: optional string Human-readable repository name. Link to this property

Link to this property root\_directory: optional string Repository directory in which build and deploy commands run. Link to this property trigger\_name: optional string Human-readable name of the build trigger. Link to this property trigger\_uuid: optional string Trigger UUID. formatuuid Link to this property

[Link to this property](<#(resource)%20workers_builds.triggers%20%3E%20(model)%20trigger_list_response%20%3E%20(schema)>)

TriggerCreateResponse object {branch\_excludes, branch\_includes, build\_caching\_enabled, 14 more }

repo\_connection: optional object {created\_on, deleted\_on, modified\_on, 6 more }

provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider.

One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property

[Link to this property](<#(resource)%20workers_builds.triggers%20%3E%20(model)%20trigger_create_response%20%3E%20(schema)>)

TriggerUpdateResponse object {branch\_excludes, branch\_includes, build\_caching\_enabled, 14 more }

repo\_connection: optional object {created\_on, deleted\_on, modified\_on, 6 more }

provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider.

One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property

[Link to this property](<#(resource)%20workers_builds.triggers%20%3E%20(model)%20trigger_update_response%20%3E%20(schema)>) TriggerDeleteResponse = unknown [Link to this property](<#(resource)%20workers_builds.triggers%20%3E%20(model)%20trigger_delete_response%20%3E%20(schema)>) TriggerPurgeCacheResponse = unknown [Link to this property](<#(resource)%20workers_builds.triggers%20%3E%20(model)%20trigger_purge_cache_response%20%3E%20(schema)>)

TriggerCreateBuildResponse object {build\_outcome, build\_trigger\_metadata, build\_uuid, 10 more }

build\_outcome: optional "success"or "fail"or "skipped"or 2 more

One of the following: "success" Link to this property "fail" Link to this property "skipped" Link to this property "cancelled" Link to this property "terminated" Link to this property

Link to this property

build\_trigger\_metadata: optional object {author, branch, build\_command, 11 more }

author: optional string Link to this property branch: optional string Git branch name. Link to this property build\_command: optional string Command to build the Worker. Link to this property build\_token\_name: optional string Link to this property build\_token\_uuid: optional string UUID of the build token used when deploying the Worker. formatuuid Link to this property

build\_trigger\_source: optional "push"or "pull\_request"or "manual"or "api"

One of the following: "push" Link to this property "pull\_request" Link to this property "manual" Link to this property "api" Link to this property

Link to this property commit\_hash: optional string Git commit hash Link to this property commit\_message: optional string Link to this property deploy\_command: optional string Command to deploy the Worker. Link to this property environment\_variables: optional map\[string] Link to this property provider\_account\_name: optional string Human-readable name of the account or namespace that owns the repository. Link to this property

provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider.

One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property

Link to this property repo\_name: optional string Human-readable repository name. Link to this property root\_directory: optional string Repository directory in which build and deploy commands run. Link to this property

Link to this property build\_uuid: optional string Build UUID. formatuuid Link to this property created\_on: optional string formatdate-time Link to this property

deploy\_hook: optional object {deploy\_hook\_name }

deploy\_hook\_name: optional string Deploy hook name (1-58 characters). maxLength58 minLength1 Link to this property

Link to this property initializing\_on: optional string formatdate-time Link to this property modified\_on: optional string formatdate-time Link to this property preview\_url: optional string URL serving the Worker version this build deployed. Only returned by Get build by UUID, and only once the build has produced a preview artifact. formaturi Link to this property

pull\_request: optional object {closed\_on, created\_on, pull\_request\_url }

closed\_on: optional string formatdate-time Link to this property created\_on: optional string formatdate-time Link to this property pull\_request\_url: optional string formaturi Link to this property

Link to this property running\_on: optional string formatdate-time Link to this property

status: optional "queued"or "initializing"or "running"or "stopped"

One of the following: "queued" Link to this property "initializing" Link to this property "running" Link to this property "stopped" Link to this property

Link to this property stopped\_on: optional string formatdate-time Link to this property

trigger: optional object {branch\_excludes, branch\_includes, build\_caching\_enabled, 12 more } Trigger information without build\_token\_uuid

branch\_excludes: optional array of string Branch patterns that must not start builds. Link to this property branch\_includes: optional array of string Branch patterns that can start builds. Link to this property build\_caching\_enabled: optional boolean Whether builds reuse cached dependencies and build artifacts. Link to this property build\_command: optional string Command to build the Worker. Link to this property created\_on: optional string formatdate-time Link to this property deleted\_on: optional string formatdate-time Link to this property deploy\_command: optional string Command to deploy the Worker. Link to this property external\_script\_id: optional string System-generated tag of the Worker. This is not the Worker name. Link to this property modified\_on: optional string formatdate-time Link to this property path\_excludes: optional array of string Path patterns that must not start builds. Link to this property path\_includes: optional array of string Path patterns that can start builds. Link to this property

repo\_connection: optional object {created\_on, deleted\_on, modified\_on, 6 more }

provider\_type: optional "github"or "gitlab"or "gitlab\_internal"or "origin" Source control provider.

One of the following: "github" Link to this property "gitlab" Link to this property "gitlab\_internal" Link to this property "origin" Link to this property

Link to this property

[Link to this property](<#(resource)%20workers_builds.triggers%20%3E%20(model)%20trigger_create_build_response%20%3E%20(schema)>) #### TriggersEnvironment Variables ##### [List build variables](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/subresources/environment_variables/methods/list) GET/accounts/{account\_id}/builds/triggers/{trigger\_uuid}/environment\_variables ##### [Set build variables](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/subresources/environment_variables/methods/upsert) PATCH/accounts/{account\_id}/builds/triggers/{trigger\_uuid}/environment\_variables ##### [Delete a build variable](https://developers.cloudflare.com/api/resources/workers_builds/subresources/triggers/subresources/environment_variables/methods/delete) 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 Link to this property is\_secret: boolean Whether to hide the value after it is saved. Secret values remain available to builds but appear as null when you list variables; non-secret values remain visible. Link to this property value: optional string Value is null for secret environment variables Link to this property

[Link to this property](<#(resource)%20workers_builds.triggers.environment_variables%20%3E%20(model)%20environment_variable_list_response%20%3E%20(schema)>)

EnvironmentVariableUpsertResponse = map\[object {created\_on, is\_secret, value } ]

[Link to this property](<#(resource)%20workers_builds.triggers.environment_variables%20%3E%20(model)%20environment_variable_upsert_response%20%3E%20(schema)>) EnvironmentVariableDeleteResponse = unknown [Link to this property](<#(resource)%20workers_builds.triggers.environment_variables%20%3E%20(model)%20environment_variable_delete_response%20%3E%20(schema)>)