triggers

Creates, updates, deletes, gets or lists a triggers resource.

Overview

Name	triggers
Type	Resource
Id	cloudflare.workers.triggers

Fields

The following fields are returned by SELECT queries:

list

Triggers retrieved successfully

Name	Datatype	Description
external_script_id	string	System-generated worker script tag. (example: dd7160bb9cef458093557736f4b9e75b)
build_token_name	string	(example: My Build Token)
trigger_name	string	(example: Production Deploy)
branch_excludes	array
branch_includes	array
build_caching_enabled	boolean
build_command	string	(example: npm run build)
build_token_uuid	string (uuid)	Build token UUID.
created_on	string (date-time)
deleted_on	string (date-time)
deploy_command	string	(example: npx wrangler deploy)
modified_on	string (date-time)
path_excludes	array
path_includes	array
repo_connection	object
root_directory	string	Root directory path. (example: /)
trigger_uuid	string (uuid)	Trigger UUID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, external_script_id		Get all triggers for a specific worker script
create_trigger	insert	account_id, external_script_id, build_token_uuid, trigger_name, build_command, deploy_command, root_directory, branch_includes, branch_excludes, path_includes, path_excludes, repo_connection_uuid		Create a new CI/CD trigger
update_trigger	update	account_id, trigger_uuid		Update an existing CI/CD trigger
delete_trigger	delete	account_id, trigger_uuid		Remove a CI/CD trigger
purge_build_cache	exec	account_id, trigger_uuid		Clear the build cache for a specific trigger

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
external_script_id	string
trigger_uuid	string (uuid)

SELECT examples

list

Get all triggers for a specific worker script

SELECT
external_script_id,
build_token_name,
trigger_name,
branch_excludes,
branch_includes,
build_caching_enabled,
build_command,
build_token_uuid,
created_on,
deleted_on,
deploy_command,
modified_on,
path_excludes,
path_includes,
repo_connection,
root_directory,
trigger_uuid
FROM cloudflare.workers.triggers
WHERE account_id = '{{ account_id }}' -- required
AND external_script_id = '{{ external_script_id }}' -- required
;

INSERT examples

create_trigger

Create a new CI/CD trigger

INSERT INTO cloudflare.workers.triggers (
branch_excludes,
branch_includes,
build_caching_enabled,
build_command,
build_token_uuid,
deploy_command,
external_script_id,
path_excludes,
path_includes,
repo_connection_uuid,
root_directory,
trigger_name,
account_id
)
SELECT 
'{{ branch_excludes }}' /* required */,
'{{ branch_includes }}' /* required */,
{{ build_caching_enabled }},
'{{ build_command }}' /* required */,
'{{ build_token_uuid }}' /* required */,
'{{ deploy_command }}' /* required */,
'{{ external_script_id }}' /* required */,
'{{ path_excludes }}' /* required */,
'{{ path_includes }}' /* required */,
'{{ repo_connection_uuid }}' /* required */,
'{{ root_directory }}' /* required */,
'{{ trigger_name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: triggers
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the triggers resource.
  - name: branch_excludes
    value:
      - "{{ branch_excludes }}"
  - name: branch_includes
    value:
      - "{{ branch_includes }}"
  - name: build_caching_enabled
    value: {{ build_caching_enabled }}
    default: false
  - name: build_command
    value: "{{ build_command }}"
  - name: build_token_uuid
    value: "{{ build_token_uuid }}"
    description: |
      Build token UUID.
  - name: deploy_command
    value: "{{ deploy_command }}"
  - name: external_script_id
    value: "{{ external_script_id }}"
    description: |
      System-generated worker script tag.
  - name: path_excludes
    value:
      - "{{ path_excludes }}"
  - name: path_includes
    value:
      - "{{ path_includes }}"
  - name: repo_connection_uuid
    value: "{{ repo_connection_uuid }}"
    description: |
      Repository connection UUID.
  - name: root_directory
    value: "{{ root_directory }}"
    description: |
      Root directory path.
  - name: trigger_name
    value: "{{ trigger_name }}"

UPDATE examples

update_trigger

Update an existing CI/CD trigger

UPDATE cloudflare.workers.triggers
SET 
branch_excludes = '{{ branch_excludes }}',
branch_includes = '{{ branch_includes }}',
build_caching_enabled = {{ build_caching_enabled }},
build_command = '{{ build_command }}',
build_token_uuid = '{{ build_token_uuid }}',
deploy_command = '{{ deploy_command }}',
path_excludes = '{{ path_excludes }}',
path_includes = '{{ path_includes }}',
root_directory = '{{ root_directory }}',
trigger_name = '{{ trigger_name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND trigger_uuid = '{{ trigger_uuid }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

DELETE examples

delete_trigger

Remove a CI/CD trigger

DELETE FROM cloudflare.workers.triggers
WHERE account_id = '{{ account_id }}' --required
AND trigger_uuid = '{{ trigger_uuid }}' --required
;

Lifecycle Methods

purge_build_cache

Clear the build cache for a specific trigger

EXEC cloudflare.workers.triggers.purge_build_cache 
@account_id='{{ account_id }}' --required, 
@trigger_uuid='{{ trigger_uuid }}' --required
;