Webhooks

List webhooks

Returns all configured webhooks with masked secrets.

get/api/webhooks

Response

Array of webhook objects.

idinteger required
node_idinteger

Node the webhook executes against.

namestring required
stack_namestring required
action'deploy' | 'restart' | 'stop' | 'start' | 'pull' | 'git-pull' required
secretstring required

Masked secret (e.g., ****...****). Full secret is only returned on creation.

enabled0 | 1 required
created_atinteger required

Unix timestamp (seconds).

Changes

Changed in 3 of the 36 revisions of this API.35

    • removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403

      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

  • 6aa88c4c8a4f11See the full diff
    • added the new git-pull enum value to the items/action response property for the response status 200

      response-property-enum-value-added

    • added the optional property items/node_id to the response with the 200 status

      response-optional-property-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 500

      response-property-enum-value-added

    • 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 500

      response-property-enum-value-removed