Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface WebhookDefinition

Represents information about a webhook and its definition.


  • WebhookDefinition


authentication: undefined | string

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

authenticationConfiguration: undefined | WebhookAuthConfiguration

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.

filters: undefined | WebhookFilterRule[]

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.

name: undefined | string

The name of the webhook.

targetAction: undefined | string

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.

targetPipeline: undefined | string

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