Amazon CodePipeline · JSON Structure

Amazon Codepipeline List Webhook Item Structure

The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.

Type: object Properties: 7 Required: 2
AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

ListWebhookItem is a JSON Structure definition published by Amazon CodePipeline, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

definition url errorMessage errorCode lastTriggered arn tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-structure/amazon-codepipeline-list-webhook-item-structure.json",
  "name": "ListWebhookItem",
  "description": "The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.",
  "type": "object",
  "properties": {
    "definition": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookDefinition"
        },
        {
          "description": "The detail returned for each webhook, such as the webhook authentication type and filter rules."
        }
      ]
    },
    "url": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookUrl"
        },
        {
          "description": "A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one."
        }
      ]
    },
    "errorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookErrorMessage"
        },
        {
          "description": "The text of the error message about the webhook."
        }
      ]
    },
    "errorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookErrorCode"
        },
        {
          "description": "The number code of the error."
        }
      ]
    },
    "lastTriggered": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookLastTriggered"
        },
        {
          "description": "The date and time a webhook was last successfully triggered, in timestamp format."
        }
      ]
    },
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the webhook."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "Specifies the tags applied to the webhook."
        }
      ]
    }
  },
  "required": [
    "definition",
    "url"
  ]
}