Webhooks

APIs to create, update, list webhooks

ListWebhooks

get

Returns List of Webhook Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

Query parameters

pageinteger · int64Optional

Current page number

Default: 1

sizeinteger · int64Optional

Number of items per page

Default: 20

sort_orderstringOptional

sortOrder

sort_fieldstringOptional

sortField

search_termstringOptional

search Term.

Responses

200

response for list webhooks

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/webhooks

GET /api/v1/registry/{registry_ref}/webhooks HTTP/1.1
Accept: */*

{
  "data": {
    "itemCount": 1,
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1,
    "webhooks": [
      {
        "createdAt": "text",
        "createdBy": 1,
        "description": "text",
        "enabled": true,
        "extraHeaders": [
          {
            "key": "text",
            "masked": false,
            "value": "text"
          }
        ],
        "identifier": "text",
        "insecure": true,
        "internal": true,
        "latestExecutionResult": "SUCCESS",
        "modifiedAt": "text",
        "name": "text",
        "secretIdentifier": "text",
        "secretSpaceId": 1,
        "secretSpacePath": "text",
        "triggers": [
          "ARTIFACT_CREATION"
        ],
        "url": "text",
        "version": 1
      }
    ]
  },
  "status": "SUCCESS"
}

CreateWebhook

post

Returns Webhook Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

Body

descriptionstringOptional

enabledbooleanRequired

identifierstringRequired

insecurebooleanRequired

namestringRequired

secretIdentifierstringOptional

secretSpaceIdinteger · int64Optional

secretSpacePathstringOptional

urlstringRequired

Responses

201

response for create, get and update webhook

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

500

An unexpected server error occurred

application/json

post/v1/registry/{registry_ref}/webhooks

POST /api/v1/registry/{registry_ref}/webhooks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "description": "text",
  "enabled": true,
  "extraHeaders": [
    {
      "key": "text",
      "masked": false,
      "value": "text"
    }
  ],
  "identifier": "text",
  "insecure": true,
  "name": "text",
  "secretIdentifier": "text",
  "secretSpaceId": 1,
  "secretSpacePath": "text",
  "triggers": [
    "ARTIFACT_CREATION"
  ],
  "url": "text"
}

{
  "data": {
    "createdAt": "text",
    "createdBy": 1,
    "description": "text",
    "enabled": true,
    "extraHeaders": [
      {
        "key": "text",
        "masked": false,
        "value": "text"
      }
    ],
    "identifier": "text",
    "insecure": true,
    "internal": true,
    "latestExecutionResult": "SUCCESS",
    "modifiedAt": "text",
    "name": "text",
    "secretIdentifier": "text",
    "secretSpaceId": 1,
    "secretSpacePath": "text",
    "triggers": [
      "ARTIFACT_CREATION"
    ],
    "url": "text",
    "version": 1
  },
  "status": "SUCCESS"
}

GetWebhook

get

Returns Webhook Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

webhook_identifierstringRequired

Unique webhook identifier.

Responses

200

response for create, get and update webhook

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/webhooks/{webhook_identifier}

GET /api/v1/registry/{registry_ref}/webhooks/{webhook_identifier} HTTP/1.1
Accept: */*

{
  "data": {
    "createdAt": "text",
    "createdBy": 1,
    "description": "text",
    "enabled": true,
    "extraHeaders": [
      {
        "key": "text",
        "masked": false,
        "value": "text"
      }
    ],
    "identifier": "text",
    "insecure": true,
    "internal": true,
    "latestExecutionResult": "SUCCESS",
    "modifiedAt": "text",
    "name": "text",
    "secretIdentifier": "text",
    "secretSpaceId": 1,
    "secretSpacePath": "text",
    "triggers": [
      "ARTIFACT_CREATION"
    ],
    "url": "text",
    "version": 1
  },
  "status": "SUCCESS"
}

UpdateWebhook

put

Returns Webhook Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

webhook_identifierstringRequired

Unique webhook identifier.

Body

descriptionstringOptional

enabledbooleanRequired

identifierstringRequired

insecurebooleanRequired

namestringRequired

secretIdentifierstringOptional

secretSpaceIdinteger · int64Optional

secretSpacePathstringOptional

urlstringRequired

Responses

201

response for create, get and update webhook

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

put/v1/registry/{registry_ref}/webhooks/{webhook_identifier}

PUT /api/v1/registry/{registry_ref}/webhooks/{webhook_identifier} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 264

{
  "description": "text",
  "enabled": true,
  "extraHeaders": [
    {
      "key": "text",
      "masked": false,
      "value": "text"
    }
  ],
  "identifier": "text",
  "insecure": true,
  "name": "text",
  "secretIdentifier": "text",
  "secretSpaceId": 1,
  "secretSpacePath": "text",
  "triggers": [
    "ARTIFACT_CREATION"
  ],
  "url": "text"
}

{
  "data": {
    "createdAt": "text",
    "createdBy": 1,
    "description": "text",
    "enabled": true,
    "extraHeaders": [
      {
        "key": "text",
        "masked": false,
        "value": "text"
      }
    ],
    "identifier": "text",
    "insecure": true,
    "internal": true,
    "latestExecutionResult": "SUCCESS",
    "modifiedAt": "text",
    "name": "text",
    "secretIdentifier": "text",
    "secretSpaceId": 1,
    "secretSpacePath": "text",
    "triggers": [
      "ARTIFACT_CREATION"
    ],
    "url": "text",
    "version": 1
  },
  "status": "SUCCESS"
}

DeleteWebhook

delete

Delete a Webhook

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

webhook_identifierstringRequired

Unique webhook identifier.

Responses

200

Generic success response

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

delete/v1/registry/{registry_ref}/webhooks/{webhook_identifier}

DELETE /api/v1/registry/{registry_ref}/webhooks/{webhook_identifier} HTTP/1.1
Accept: */*

{
  "status": "SUCCESS"
}

ListWebhookExecutions

get

Returns Webhook Execution Details List

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

webhook_identifierstringRequired

Unique webhook identifier.

Query parameters

pageinteger · int64Optional

Current page number

Default: 1

sizeinteger · int64Optional

Number of items per page

Default: 20

Responses

200

list webhooks executions response

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions

GET /api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions HTTP/1.1
Accept: */*

{
  "data": {
    "executions": [
      {
        "created": 1,
        "duration": 1,
        "error": "text",
        "id": 1,
        "request": {
          "body": "text",
          "headers": "text",
          "url": "text"
        },
        "response": {
          "body": "text",
          "headers": "text",
          "status": "text",
          "statusCode": 1
        },
        "result": "SUCCESS",
        "retriggerOf": 1,
        "retriggerable": true,
        "triggerType": "ARTIFACT_CREATION",
        "webhookId": 1
      }
    ],
    "itemCount": 1,
    "pageCount": 100,
    "pageIndex": 0,
    "pageSize": 1
  },
  "status": "SUCCESS"
}

GetWebhookExecution

get

Returns Webhook Execution Details

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

webhook_identifierstringRequired

Unique webhook identifier.

webhook_execution_idstringRequired

Unique webhook execution identifier.

Responses

200

webhook execution response

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}

GET /api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id} HTTP/1.1
Accept: */*

{
  "data": {
    "created": 1,
    "duration": 1,
    "error": "text",
    "id": 1,
    "request": {
      "body": "text",
      "headers": "text",
      "url": "text"
    },
    "response": {
      "body": "text",
      "headers": "text",
      "status": "text",
      "statusCode": 1
    },
    "result": "SUCCESS",
    "retriggerOf": 1,
    "retriggerable": true,
    "triggerType": "ARTIFACT_CREATION",
    "webhookId": 1
  },
  "status": "SUCCESS"
}

ReTriggerWebhookExecution

get

Retrigger Webhook Execution

Path parameters

registry_refstringRequired

Reference to the scope in which the registry exists.

Format depends on the scope:

• Account-level: account_id/registry_name/+
• Organization-level: account_id/org_id/registry_name/+
• Project-level: account_id/org_id/project_id/registry_name/+

The /+ suffix is used internally to route scoped requests. It must be included exactly as shown in the URL.

Example: {"description":"Only account ID, scoped at account level","summary":"Account-level registry","value":"acc123/registry123/+"}

webhook_identifierstringRequired

Unique webhook identifier.

webhook_execution_idstringRequired

Unique webhook execution identifier.

Responses

200

webhook execution response

application/json

statusstring · enumRequired

Request processing status indicator

Possible values:

400

The request was invalid or malformed

application/json

401

Authentication failed or missing credentials

application/json

403

Access denied due to insufficient permissions

application/json

404

The requested resource was not found

application/json

500

An unexpected server error occurred

application/json

get/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger

GET /api/v1/registry/{registry_ref}/webhooks/{webhook_identifier}/executions/{webhook_execution_id}/retrigger HTTP/1.1
Accept: */*

{
  "data": {
    "created": 1,
    "duration": 1,
    "error": "text",
    "id": 1,
    "request": {
      "body": "text",
      "headers": "text",
      "url": "text"
    },
    "response": {
      "body": "text",
      "headers": "text",
      "status": "text",
      "statusCode": 1
    },
    "result": "SUCCESS",
    "retriggerOf": 1,
    "retriggerable": true,
    "triggerType": "ARTIFACT_CREATION",
    "webhookId": 1
  },
  "status": "SUCCESS"
}