Webhooks

Update webhook

Updates webhook configuration. Requires admin role.

put/api/webhooks/{id}

Path parameters

idinteger required

Numeric resource ID.

Request body

namestring
stack_namestring
action'deploy' | 'restart' | 'stop' | 'start' | 'pull' | 'git-pull'
enabledboolean
node_idinteger

Retarget the webhook to a different node.

Response

Webhook updated.

successboolean required

Example response

{
  "success": true
}

Changes

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

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

      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 500

      response-property-enum-value-removed

  • 3e94162e8e6412See the full diff
    • the name request property's maxLength was set to 100

      request-property-max-length-set

    • added the new optional request property node_id

      new-optional-request-property

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

      request-property-enum-value-added

    • added the new PAID_REQUIRED enum value to the code response property for the response status 400

      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 400

      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