Turn a deploy hook on or off

toggle_deploy_hook

Turns one deploy hook on or off without deleting it.

POST /v1/toggle_deploy_hookScopeconfig:writeMakes changes

A hook that is turned off keeps its URL and its call log. Calls to it are still logged, as disabled, but they start nothing until it is turned back on.

They still count toward the 10 calls a minute, so past that they are answered as rate-limited and only the first of them is logged. This is the reversible way to stop a hook, and usually what someone means by "stop this hook". See Deploy hooks.

Request

Call it with a POST to https://api.modulify.ai/v1/toggle_deploy_hook, sending the inputs below as a JSON object. The token needs the config:write scope.

It makes changes, so send an Idempotency-Key header whenever you might retry it. A retry with the same key gets the first answer back instead of running again.

curl -X POST https://api.modulify.ai/v1/toggle_deploy_hook \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID","hookId":"HOOK_ID","enabled":true}'

Over MCP, the same method is the toggle_deploy_hook tool.

Inputs

Input	Type	Required	Description
`projectId`	string	Yes	The site id.
`hookId`	string	Yes	The hook id from `list_deploy_hooks`.
`enabled`	boolean	Yes	True to turn it on, false to turn it off.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.