Sign in

v34

latestOpenAPI 3.1.0AGPL-3.0-onlyraw.githubusercontent.com2026-08-018932140.9 KB
Webhooks

Create webhook

Creates a new webhook for a stack. The webhook secret is auto-generated and only returned in the creation response. Requires admin role.

post/api/webhooks

Request body

namestring required
stack_namestring required

Target stack name.

action'deploy' | 'restart' | 'stop' | 'start' | 'pull' | 'git-pull' required

Action to execute when the webhook is triggered. git-pull requires a Git source attached to the stack.

enabledboolean
node_idinteger

Node the webhook executes against. Defaults to the request's resolved node or the default node.

Example request

{
  "name": "GitHub Deploy Hook",
  "stack_name": "my-app"
}

Response

Webhook created. The secret field is the HMAC signing key; save it now.

idinteger required
secretstring required

HMAC-SHA256 signing secret. Store securely; this is the only time it's returned in full.