---
title: Create a deploy hook
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Workers Builds](https://developers.cloudflare.com/api/resources/workers_builds)
[Deploy Hooks](https://developers.cloudflare.com/api/resources/workers_builds/subresources/deploy_hooks)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Create a deploy hook
POST/accounts/{account\_id}/builds/workers/{script\_name}/deploy\_hooks
Create an HTTP hook that starts a build for a selected Worker branch.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Workers CI Write`
##### P ath ParametersExpand Collapse
account\_id: string
Account identifier.
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
script\_name: string
Human-readable name of the Worker.
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20script_name%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
branch: string
Git branch name.
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20branch%20%3E%20(schema)>)
deploy\_hook\_name: string
Deploy hook name (1-58 characters).
maxLength58
minLength1
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20deploy_hook_name%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {message, code }
message: string
Link to this property
code: optional number
Link to this property
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of string
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {branch, created\_on, deploy\_hook\_name, 3 more }
branch: optional string
Git branch name.
Link to this property
created\_on: optional string
formatdate-time
Link to this property
deploy\_hook\_name: optional string
Deploy hook name (1-58 characters).
maxLength58
minLength1
Link to this property
deploy\_hook\_uuid: optional string
Deploy hook UUID.
formatuuid
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
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: boolean
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {count, page, per\_page, 2 more }
count: optional number
Link to this property
page: optional number
Link to this property
per\_page: optional number
Link to this property
total\_count: optional number
Link to this property
total\_pages: optional number
Link to this property
[Link to this property](<#(resource)%20workers_builds.deploy_hooks%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### Create a deploy hook
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/builds/workers/$SCRIPT_NAME/deploy_hooks \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"branch": "main",
"deploy_hook_name": "Production Deploy Hook"
}'
```
200 example
400 example
401 example
404 example
409 example
```
{
"errors": [
{
"message": "Not found",
"code": 12000
}
],
"messages": [
"string"
],
"result": {
"branch": "main",
"created_on": "2019-12-27T18:11:19.117Z",
"deploy_hook_name": "Production Deploy Hook",
"deploy_hook_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"external_script_id": "dd7160bb9cef458093557736f4b9e75b",
"modified_on": "2019-12-27T18:11:19.117Z"
},
"success": true,
"result_info": {
"count": 25,
"page": 1,
"per_page": 50,
"total_count": 150,
"total_pages": 3
}
}
```
```
{
"errors": [
{
"code": 12002,
"message": "Invalid request body"
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 12005,
"message": "Missing token from authorization header"
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 12000,
"message": "Not found"
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 12049,
"message": "Resource already exists"
}
],
"messages": [],
"result": null,
"success": false
}
```
##### Returns Examples
200 example
400 example
401 example
404 example
409 example
```
{
"errors": [
{
"message": "Not found",
"code": 12000
}
],
"messages": [
"string"
],
"result": {
"branch": "main",
"created_on": "2019-12-27T18:11:19.117Z",
"deploy_hook_name": "Production Deploy Hook",
"deploy_hook_uuid": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"external_script_id": "dd7160bb9cef458093557736f4b9e75b",
"modified_on": "2019-12-27T18:11:19.117Z"
},
"success": true,
"result_info": {
"count": 25,
"page": 1,
"per_page": 50,
"total_count": 150,
"total_pages": 3
}
}
```
```
{
"errors": [
{
"code": 12002,
"message": "Invalid request body"
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 12005,
"message": "Missing token from authorization header"
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 12000,
"message": "Not found"
}
],
"messages": [],
"result": null,
"success": false
}
```
```
{
"errors": [
{
"code": 12049,
"message": "Resource already exists"
}
],
"messages": [],
"result": null,
"success": false
}
```