STstudio-saelix
Webhooks

Create webhook

Changed on

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

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/webhooks
  • Auth
    HTTP bearer

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.

Changes

  • d58cf9d6195bRevision changes
    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

    • info

      removed the ADMIRAL_REQUIRED enum value from the response property for the response status

  • 3e94162e8e64Revision changes
    • warning

      the request property's maxLength was set to 100

    • info

      added the new optional request property

    • info

      added the new git-pull enum value to the request property