Webhooks

CreateWebhook

Changed on

Returns Webhook Details

post/registry/{registry_ref}/webhooks

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/registry/{registry_ref}/webhooks
  • Auth: none declared

Path parameters

registry_refstring required

Unique path identifier for the final registry in the branch. The value can be provided either as a fully URL-encoded path (e.g., organization%2Fproject%2Fregistry) or as a plain path ending with a trailing plus sign (+) as separator (e.g., organization/project/registry/+).

Request body

identifierstring required
namestring required
descriptionstring
urlstring required
enabledboolean required
insecureboolean required
secretIdentifierstring
secretSpacePathstring
secretSpaceIdinteger
triggersTrigger[]

Response

response for create, get and update webhook

status'SUCCESS' | 'FAILURE' | 'ERROR' required

Indicates if the request was successful or not

Changes

  • fc6dc4501402Revision changes
    • info

      added the new optional request property //

    • info

      added the optional property /// to the response with the status

  • c55e0097ca2aRevision changes
    • breaking

      removed the enum value ARTIFACT_MODIFICATION of the request property /

    • info

      removed the ARTIFACT_MODIFICATION enum value from the // response property for the response status