API Reference

Workers Builds

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Deploy Hooks

List deploy hooks

GET/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks

Create a deploy hook

POST/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks

Get a deploy hook

GET/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}

Update a deploy hook

PUT/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}

Delete a deploy hook

DELETE/accounts/{account_id}/builds/workers/{script_name}/deploy_hooks/{deploy_hook_uuid}

Trigger deploy hook

POST/workers/builds/deploy_hooks/{deploy_hook_uuid}

ModelsExpand Collapse

DeployHookListResponse = unknown or array of unknown

One of the following:

unknown

array of unknown

DeployHookCreateResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }

One of the following:

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

DeployHookGetResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }

One of the following:

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

DeployHookUpdateResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }

One of the following:

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

DeployHookDeleteResponse = object { branch, created_on, deploy_hook_name, 3 more } or object { branch, created_on, deploy_hook_name, 3 more }

One of the following:

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

object { branch, created_on, deploy_hook_name, 3 more }

branch: optional string

Git branch name.

created_on: optional string

formatdate-time

deploy_hook_name: optional string

Deploy hook name (1-58 characters).

maxLength58

minLength1

deploy_hook_uuid: optional string

Deploy hook UUID.

formatuuid

external_script_id: optional string

System-generated tag of the Worker. This is not the Worker name.

modified_on: optional string

formatdate-time

DeployHookTriggerResponse = object { already_exists, build_uuid, created_on, status } or object { already_exists, build_uuid, created_on, status }

One of the following:

object { already_exists, build_uuid, created_on, status }

already_exists: optional boolean

True if a pending build already exists for this branch

build_uuid: optional string

Build UUID.

formatuuid

created_on: optional string

formatdate-time

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

One of the following:

"queued"

"initializing"

"running"

"stopped"

object { already_exists, build_uuid, created_on, status }

already_exists: optional boolean

True if a pending build already exists for this branch

build_uuid: optional string

Build UUID.

formatuuid

created_on: optional string

formatdate-time

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

One of the following:

"queued"

"initializing"

"running"

"stopped"