Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. codepipeline
  5. getWebhook

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.codepipeline.getWebhook

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::CodePipeline::Webhook

    Using getWebhook

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebhook(args: GetWebhookArgs, opts?: InvokeOptions): Promise<GetWebhookResult>
function getWebhookOutput(args: GetWebhookOutputArgs, opts?: InvokeOptions): Output<GetWebhookResult>
    def get_webhook(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetWebhookResult
def get_webhook_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetWebhookResult]
    func LookupWebhook(ctx *Context, args *LookupWebhookArgs, opts ...InvokeOption) (*LookupWebhookResult, error)
func LookupWebhookOutput(ctx *Context, args *LookupWebhookOutputArgs, opts ...InvokeOption) LookupWebhookResultOutput

    > Note: This function is named LookupWebhook in the Go SDK.

    public static class GetWebhook 
{
    public static Task<GetWebhookResult> InvokeAsync(GetWebhookArgs args, InvokeOptions? opts = null)
    public static Output<GetWebhookResult> Invoke(GetWebhookInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
public static Output<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:codepipeline:getWebhook
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    logical id of the webhook
    Id string
    logical id of the webhook
    id String
    logical id of the webhook
    id string
    logical id of the webhook
    id str
    logical id of the webhook
    id String
    logical id of the webhook

    getWebhook Result

    The following output properties are available:

    Authentication Pulumi.AwsNative.CodePipeline.WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    AuthenticationConfiguration Pulumi.AwsNative.CodePipeline.Outputs.WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    Filters List<Pulumi.AwsNative.CodePipeline.Outputs.WebhookFilterRule>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    Id string
    logical id of the webhook
    TargetAction string
    The name of the action in a pipeline you want to connect to the webhook.
    TargetPipeline string
    The name of the pipeline you want to connect to the webhook.
    Url string
    The webhook URL generated by AWS CodePipeline
    Authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    AuthenticationConfiguration WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    Filters []WebhookFilterRule
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    Id string
    logical id of the webhook
    TargetAction string
    The name of the action in a pipeline you want to connect to the webhook.
    TargetPipeline string
    The name of the pipeline you want to connect to the webhook.
    Url string
    The webhook URL generated by AWS CodePipeline
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authenticationConfiguration WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters List<WebhookFilterRule>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    id String
    logical id of the webhook
    targetAction String
    The name of the action in a pipeline you want to connect to the webhook.
    targetPipeline String
    The name of the pipeline you want to connect to the webhook.
    url String
    The webhook URL generated by AWS CodePipeline
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authenticationConfiguration WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters WebhookFilterRule[]
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    id string
    logical id of the webhook
    targetAction string
    The name of the action in a pipeline you want to connect to the webhook.
    targetPipeline string
    The name of the pipeline you want to connect to the webhook.
    url string
    The webhook URL generated by AWS CodePipeline
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authentication_configuration WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters Sequence[WebhookFilterRule]
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    id str
    logical id of the webhook
    target_action str
    The name of the action in a pipeline you want to connect to the webhook.
    target_pipeline str
    The name of the pipeline you want to connect to the webhook.
    url str
    The webhook URL generated by AWS CodePipeline
    authentication "GITHUB_HMAC" | "IP" | "UNAUTHENTICATED"
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authenticationConfiguration Property Map
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters List<Property Map>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    id String
    logical id of the webhook
    targetAction String
    The name of the action in a pipeline you want to connect to the webhook.
    targetPipeline String
    The name of the pipeline you want to connect to the webhook.
    url String
    The webhook URL generated by AWS CodePipeline

    Supporting Types

    WebhookAuthConfiguration

    AllowedIpRange string
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    SecretToken string
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    AllowedIpRange string
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    SecretToken string
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowedIpRange String
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secretToken String
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowedIpRange string
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secretToken string
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowed_ip_range str
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secret_token str
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
    allowedIpRange String
    The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
    secretToken String
    The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

    WebhookAuthentication

    WebhookFilterRule

    JsonPath 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.
    MatchEquals string
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    JsonPath 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.
    MatchEquals string
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    jsonPath 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.
    matchEquals String
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    jsonPath 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.
    matchEquals string
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    json_path str
    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.
    match_equals str
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.
    jsonPath 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.
    matchEquals String
    The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.34.0 published on Friday, Sep 12, 2025 by Pulumi
    pulumi/pulumi-aws-native