Deploy hook
The one REST endpoint that takes an API token instead of the session cookie, for git providers, CI and scripts.
A git provider, a CI job or a script can deploy an app without composing a query. It stays REST because a webhook sender only posts a URL.
curl -X POST -H "Authorization: Bearer deplo_your_token" \
https://deplo.example.com/api/apps/prj_123/deploy-hook/<token>Both secrets are required. The URL's <token> says which app: read it back
with revealAppDeployHook, replace it with rotateAppDeployHook, switch the
hook off entirely with setAppDeployHookEnabled. The bearer token says who,
and must itself hold deploy_apps in that app's team (the Deploy hook &
CI template is exactly this set). The deploy runs through exactly the
gates the dashboard button does.
Answers 200 with the queued deployment:
{
"deploymentId": "dpl_1a2b3c",
"appId": "prj_123",
"status": "queued",
"url": "https://shop.example.com"
}Prop
Type
See also
Did this page help you?