AWS CodePipeline
API Reference (API Version 2015-07-09)

WebhookDefinition

Represents information about a webhook and its definition.

Contents

authentication

Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

  • GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/

  • IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.

Type: String

Valid Values: GITHUB_HMAC | IP | UNAUTHENTICATED

Required: Yes

authenticationConfiguration

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Type: WebhookAuthConfiguration object

Required: Yes

filters

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.

Type: Array of WebhookFilterRule objects

Array Members: Maximum number of 5 items.

Required: Yes

name

The name of the webhook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

targetAction

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

targetPipeline

The name of the pipeline you want to connect to the webhook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: