Amazon CodePipeline · JSON Structure

Amazon Codepipeline Webhook Definition Structure

Represents information about a webhook and its definition.

Type: object Properties: 6 Required: 6
AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

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

Properties

name targetPipeline targetAction filters authentication authenticationConfiguration

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-webhook-definition-structure.json",
  "name": "WebhookDefinition",
  "description": "Represents information about a webhook and its definition.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookName"
        },
        {
          "description": "The name of the webhook."
        }
      ]
    },
    "targetPipeline": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineName"
        },
        {
          "description": "The name of the pipeline you want to connect to the webhook."
        }
      ]
    },
    "targetAction": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionName"
        },
        {
          "description": "The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline."
        }
      ]
    },
    "filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookFilters"
        },
        {
          "description": "A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started."
        }
      ]
    },
    "authentication": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookAuthenticationType"
        },
        {
          "description": "<p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p> <ul> <li> <p>For information about the authentication scheme implemented by GITHUB_HMAC, see <a href=\"https://developer.github.com/webhooks/securing/\">Securing your webhooks</a> on the GitHub Developer website.</p> </li> <li> <p> IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.</p> </li> <li> <p> UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.</p> </li> </ul>"
        }
      ]
    },
    "authenticationConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebhookAuthConfiguration"
        },
        {
          "description": "Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the <code>SecretToken </code>property must be set. For IP, only the <code>AllowedIPRange </code>property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set."
        }
      ]
    }
  },
  "required": [
    "name",
    "targetPipeline",
    "targetAction",
    "filters",
    "authentication",
    "authenticationConfiguration"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/amazon-codepipeline-webhook-definition-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.