AWS CloudFormation
User Guide (Version )

AWS::CodePipeline::Webhook WebhookFilterRule

The event criteria that specify when a webhook notification is sent to your URL.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "JsonPath" : String, "MatchEquals" : String }

YAML

JsonPath: String MatchEquals: String

Properties

JsonPath

A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field, otherwise the request will be ignored. For more information about JsonPath expressions, see Java JsonPath implementation in GitHub.

Required: Yes

Type: String

Minimum: 1

Maximum: 150

Update requires: No interruption

MatchEquals

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

Required: No

Type: String

Minimum: 1

Maximum: 150

Update requires: No interruption

On this page: