interface WebhookFilterRuleProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.CfnWebhook.WebhookFilterRuleProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CfnWebhook_WebhookFilterRuleProperty`
Java	`software.amazon.awscdk.services.codepipeline.CfnWebhook.WebhookFilterRuleProperty`
Python	`aws_cdk.aws_codepipeline.CfnWebhook.WebhookFilterRuleProperty`
TypeScript	`aws-cdk-lib` » `aws_codepipeline` » `CfnWebhook` » `WebhookFilterRuleProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const webhookFilterRuleProperty: codepipeline.CfnWebhook.WebhookFilterRuleProperty = {
  jsonPath: 'jsonPath',

  // the properties below are optional
  matchEquals: 'matchEquals',
};

Properties

Name	Type	Description
jsonPath	`string`	A JsonPath expression that is applied to the body/payload of the webhook.
matchEquals?	`string`	The value selected by the `JsonPath` expression must match what is supplied in the `MatchEquals` field.

jsonPath

Type: string

A JsonPath expression that is 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 is ignored. For more information, see Java JsonPath implementation in GitHub.

matchEquals?

Type: string (optional)

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.

Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. 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 "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .