deploy_hooks

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

Overview

Name	deploy_hooks
Type	Resource
Id	cloudflare.workers.deploy_hooks

Fields

The following fields are returned by SELECT queries:

get

Deploy hook retrieved successfully

Name	Datatype	Description
external_script_id	string	System-generated worker script tag. (example: dd7160bb9cef458093557736f4b9e75b)
deploy_hook_name	string	Deploy hook name (1-58 characters). (example: Production Deploy Hook)
branch	string	Git branch name. (example: main)
created_on	string (date-time)
deploy_hook_uuid	string (uuid)	Deploy hook UUID.
modified_on	string (date-time)

list

Deploy hooks retrieved successfully

Name	Datatype	Description
external_script_id	string	System-generated worker script tag. (example: dd7160bb9cef458093557736f4b9e75b)
deploy_hook_name	string	Deploy hook name (1-58 characters). (example: Production Deploy Hook)
branch	string	Git branch name. (example: main)
created_on	string (date-time)
deploy_hook_uuid	string (uuid)	Deploy hook UUID.
latest_build	object
modified_on	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, script_name, deploy_hook_uuid		Get details of a specific deploy hook.
list	select	account_id, script_name		Get all deploy hooks for a specific worker script.
create_deploy_hook	insert	account_id, script_name, deploy_hook_name, branch		Create a new deploy hook for a worker script.
trigger_deploy_hook	insert	deploy_hook_uuid		Trigger a build using a deploy hook. This endpoint does not require authentication - the deploy_hook_uuid acts as a secret token.
update_deploy_hook	replace	account_id, script_name, deploy_hook_uuid, deploy_hook_name, branch		Update an existing deploy hook.
delete_deploy_hook	delete	account_id, script_name, deploy_hook_uuid		Delete a deploy hook.

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.
deploy_hook_uuid	string (uuid)	Deploy hook UUID
script_name	string	The Worker script name.

SELECT examples

get

Get details of a specific deploy hook.

SELECT
external_script_id,
deploy_hook_name,
branch,
created_on,
deploy_hook_uuid,
modified_on
FROM cloudflare.workers.deploy_hooks
WHERE account_id = '{{ account_id }}' -- required
AND script_name = '{{ script_name }}' -- required
AND deploy_hook_uuid = '{{ deploy_hook_uuid }}' -- required
;

list

Get all deploy hooks for a specific worker script.

SELECT
external_script_id,
deploy_hook_name,
branch,
created_on,
deploy_hook_uuid,
latest_build,
modified_on
FROM cloudflare.workers.deploy_hooks
WHERE account_id = '{{ account_id }}' -- required
AND script_name = '{{ script_name }}' -- required
;

INSERT examples

create_deploy_hook

Create a new deploy hook for a worker script.

INSERT INTO cloudflare.workers.deploy_hooks (
branch,
deploy_hook_name,
account_id,
script_name
)
SELECT 
'{{ branch }}' /* required */,
'{{ deploy_hook_name }}' /* required */,
'{{ account_id }}',
'{{ script_name }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

trigger_deploy_hook

Trigger a build using a deploy hook. This endpoint does not require authentication - the deploy_hook_uuid acts as a secret token.

INSERT INTO cloudflare.workers.deploy_hooks (
deploy_hook_uuid
)
SELECT 
'{{ deploy_hook_uuid }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: deploy_hooks
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the deploy_hooks resource.
  - name: script_name
    value: "{{ script_name }}"
    description: Required parameter for the deploy_hooks resource.
  - name: deploy_hook_uuid
    value: "{{ deploy_hook_uuid }}"
    description: Required parameter for the deploy_hooks resource.
  - name: branch
    value: "{{ branch }}"
    description: |
      Git branch name.
  - name: deploy_hook_name
    value: "{{ deploy_hook_name }}"
    description: |
      Deploy hook name (1-58 characters).

REPLACE examples

update_deploy_hook

Update an existing deploy hook.

REPLACE cloudflare.workers.deploy_hooks
SET 
branch = '{{ branch }}',
deploy_hook_name = '{{ deploy_hook_name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND script_name = '{{ script_name }}' --required
AND deploy_hook_uuid = '{{ deploy_hook_uuid }}' --required
AND deploy_hook_name = '{{ deploy_hook_name }}' --required
AND branch = '{{ branch }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

DELETE examples

delete_deploy_hook

Delete a deploy hook.

DELETE FROM cloudflare.workers.deploy_hooks
WHERE account_id = '{{ account_id }}' --required
AND script_name = '{{ script_name }}' --required
AND deploy_hook_uuid = '{{ deploy_hook_uuid }}' --required
;