Webhooks

Trigger webhook

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

Path parameters

idinteger required

Numeric resource ID.

Request body

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

Changed in 4 of the 36 revisions of this API.2418

Jun 4, 2026d58cf9d6195b4See the full diff
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 429
  response-property-enum-value-removed
- ○
  removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500
  response-property-enum-value-removed
May 23, 20266aa88c4c8a4f1See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
May 23, 20263e94162e8e6429See the full diff
- ▲
  request body became required
  request-body-became-required
- ▲
  request property action was restricted to a list of enum values
  request-property-became-enum
- ○
  added the new deploy enum value to the request property action
  request-property-enum-value-added
- ○
  added the new git-pull enum value to the request property action
  request-property-enum-value-added
- ○
  added the new pull enum value to the request property action
  request-property-enum-value-added
- ○
  added the new restart enum value to the request property action
  request-property-enum-value-added
- ○
  added the new start enum value to the request property action
  request-property-enum-value-added
- ○
  added the new stop enum value to the request property action
  request-property-enum-value-added
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
Apr 5, 20267464894ea58244See the full diff
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 403
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new PAID_REQUIRED enum value to the code response property for the response status 500
  response-property-enum-value-added
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the PRO_REQUIRED enum value from the code response property for the response status 500
  response-property-enum-value-removed

Full history