List deploy hooks
list_deploy_hooks
Lists the deploy hooks on a site with their name, whether each is on and how their calls went.
A deploy hook is a secret URL that starts a publish of the site when anything calls it with a plain GET, which is how an outside system such as a CI pipeline or a CMS rebuilds the site. Each hook comes back with when it was last called and how that call went, and Calls, the number of calls in the last 30 days (total) and how many of them started a build (started).
Each hook carries Masked_Url, the URL with its secret part hidden, which tells hooks apart but cannot be called. The real URL is never returned here. Read it with get_deploy_hook_url, which needs the separate credentials:reveal scope.
A site holds at most 10 hooks, so one call returns all of them. See Deploy hooks.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |