STstudio-saelix
Webhooks

Trigger webhook

Changed on

Externally triggers a webhook action. This endpoint is public but requires a valid HMAC-SHA256 signature in the X-Webhook-Signature header. Sign the exact raw bytes of the request body; an empty body is rejected.

Compute the signature as: sha256= + HMAC-SHA256(raw_request_body, webhook_secret).

Every unauthenticated rejection (unknown id, disabled webhook, missing or invalid signature, empty body) returns the same 404 response so callers cannot enumerate webhook ids from the response surface.

post/api/webhooks/{id}/trigger

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/webhooks/{id}/trigger
  • Auth
    API key in header X-Webhook-Signature

Path parameters

idinteger required

Numeric resource ID.

Request body

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

Override the default webhook action. Must be one of the allowed actions.

Response

Webhook accepted and action queued.

messagestring required
actionstring required

Example response

{
  "message": "Webhook accepted",
  "action": "deploy"
}

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

    • info

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

  • 6aa88c4c8a4fRevision changes
    • info

      added the non-success response with the status