Create a deploy hook
create_deploy_hook
Creates a deploy hook, a secret URL that publishes the site whenever something calls it with a plain GET.
Scopeconfig:writeMakes changes
The hook is created turned on, and a call to it needs no header and no body. A site holds at most 10 hooks and the call is refused once that is reached.
The URL is not returned. Read it with get_deploy_hook_url, which needs the separate credentials:reveal scope, or copy it from the hook's row in the Deploy hooks tab.
Only one build runs per site at a time, so a call made while a build is running is answered as already building and starts nothing. Each hook accepts at most 10 calls a minute. See Deploy hooks.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
name |
string | Yes | A label that says what will call the hook, for example GitHub Actions. It cannot be empty, and it is cut to 64 characters. |