1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. codepipeline
  6. Webhook

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::CodePipeline::Webhook

    Create Webhook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
    @overload
    def Webhook(resource_name: str,
                args: WebhookArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Webhook(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                authentication: Optional[WebhookAuthentication] = None,
                authentication_configuration: Optional[WebhookAuthConfigurationArgs] = None,
                filters: Optional[Sequence[WebhookFilterRuleArgs]] = None,
                target_action: Optional[str] = None,
                target_pipeline: Optional[str] = None,
                name: Optional[str] = None,
                register_with_third_party: Optional[bool] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                target_pipeline_version: Optional[int] = None)
    func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
    public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
    public Webhook(String name, WebhookArgs args)
    public Webhook(String name, WebhookArgs args, CustomResourceOptions options)
    
    type: aws-native:codepipeline:Webhook
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_codepipeline_webhook" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Webhook Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Webhook resource accepts the following input properties:

    Authentication Pulumi.AwsNative.CodePipeline.WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    AuthenticationConfiguration Pulumi.AwsNative.CodePipeline.Inputs.WebhookAuthConfiguration
    Properties that configure the authentication applied to incoming webhook trigger requests
    Filters List<Pulumi.AwsNative.CodePipeline.Inputs.WebhookFilterRule>
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    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.
    Name string
    The name of the webhook
    RegisterWithThirdParty bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    TargetPipelineVersion int
    The version number of the pipeline to be connected to the trigger request.
    Authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    AuthenticationConfiguration WebhookAuthConfigurationArgs
    Properties that configure the authentication applied to incoming webhook trigger requests
    Filters []WebhookFilterRuleArgs
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    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.
    Name string
    The name of the webhook
    RegisterWithThirdParty bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    TargetPipelineVersion int
    The version number of the pipeline to be connected to the trigger request.
    authentication "GITHUB_HMAC" | "IP" | "UNAUTHENTICATED"
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authentication_configuration object
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters list(object)
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    target_action string
    The name of the action in a pipeline you want to connect to the webhook.
    target_pipeline string
    The name of the pipeline you want to connect to the webhook.
    name string
    The name of the webhook
    register_with_third_party bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    tags list(object)
    An array of key-value pairs to apply to this resource.
    target_pipeline_version number
    The version number of the pipeline to be connected to the trigger request.
    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
    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.
    name String
    The name of the webhook
    registerWithThirdParty Boolean
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    targetPipelineVersion Integer
    The version number of the pipeline to be connected to the trigger request.
    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
    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.
    name string
    The name of the webhook
    registerWithThirdParty boolean
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    targetPipelineVersion number
    The version number of the pipeline to be connected to the trigger request.
    authentication WebhookAuthentication
    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
    authentication_configuration WebhookAuthConfigurationArgs
    Properties that configure the authentication applied to incoming webhook trigger requests
    filters Sequence[WebhookFilterRuleArgs]
    A list of rules applied to the body/payload sent in the POST request to a webhook URL
    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.
    name str
    The name of the webhook
    register_with_third_party bool
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    target_pipeline_version int
    The version number of the pipeline to be connected to the trigger request.
    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
    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.
    name String
    The name of the webhook
    registerWithThirdParty Boolean
    Configures a connection between the webhook that was created and the external tool with events to be detected.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    targetPipelineVersion Number
    The version number of the pipeline to be connected to the trigger request.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Webhook resource produces the following output properties:

    AwsId string
    logical id of the webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The webhook URL generated by AWS CodePipeline
    AwsId string
    logical id of the webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The webhook URL generated by AWS CodePipeline
    aws_id string
    logical id of the webhook
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The webhook URL generated by AWS CodePipeline
    awsId String
    logical id of the webhook
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The webhook URL generated by AWS CodePipeline
    awsId string
    logical id of the webhook
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The webhook URL generated by AWS CodePipeline
    aws_id str
    logical id of the webhook
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The webhook URL generated by AWS CodePipeline
    awsId String
    logical id of the webhook
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The webhook URL generated by AWS CodePipeline

    Look up Existing Webhook Resource

    Get an existing Webhook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Webhook
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Webhook
    func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)
    public static Webhook Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Webhook get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingWebhook:    type: aws-native:codepipeline:Webhook    get:      id: ${id}
    import {
      to = aws-native_codepipeline_webhook.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state WebhookState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WebhookAuthConfiguration, WebhookAuthConfigurationArgs

    Properties that configure the authentication applied to incoming webhook trigger requests

    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 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.
    secret_token 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

    Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

    NameValue
    GithubHmacGITHUB_HMAC
    IpIP
    UnauthenticatedUNAUTHENTICATED
    NameValue
    WebhookAuthenticationGithubHmacGITHUB_HMAC
    WebhookAuthenticationIpIP
    WebhookAuthenticationUnauthenticatedUNAUTHENTICATED
    Value
    GITHUB_HMAC
    IP
    UNAUTHENTICATED
    NameValue
    GithubHmacGITHUB_HMAC
    IpIP
    UnauthenticatedUNAUTHENTICATED
    NameValue
    GithubHmacGITHUB_HMAC
    IpIP
    UnauthenticatedUNAUTHENTICATED
    NameValue
    GITHUB_HMACGITHUB_HMAC
    IPIP
    UNAUTHENTICATEDUNAUTHENTICATED
    Value
    GITHUB_HMAC
    IP
    UNAUTHENTICATED

    WebhookFilterRule, WebhookFilterRuleArgs

    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.

    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 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.
    match_equals 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 aws-native logo AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial