WebhookDefinition
import type { WebhookDefinition } from "https://aws-api.deno.dev/v0.3/services/codepipeline.ts?docs=full";Represents information about a webhook and its definition.
interface WebhookDefinition {
authentication: WebhookAuthenticationType;
authenticationConfiguration: WebhookAuthConfiguration;
filters: WebhookFilterRule[];
name: string;
targetAction: string;
targetPipeline: string;
}§Properties
§
authentication: WebhookAuthenticationType
[src]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: WebhookAuthConfiguration
[src]Properties that configure the authentication applied to incoming webhook trigger requests.
The required properties depend on the authentication type.
For GITHUB_HMAC, only the SecretTokenproperty must be set.
For IP, only the AllowedIPRangeproperty must be set to a valid CIDR range.
For UNAUTHENTICATED, no properties can be set.
§
filters: WebhookFilterRule[]
[src]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.