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

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

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi
aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.76.0
published on Monday, Aug 24, 2026 by Pulumi

    Resource Type definition for AWS::Amplify::Webhook. Creates a webhook on an Amplify app.

    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,
                branch_name: Optional[str] = None,
                app_id: Optional[str] = None,
                description: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = 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:amplify:Webhook
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_amplify_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:

    BranchName string
    The name for a branch that is part of an Amplify app.
    AppId string
    The unique ID for an Amplify app.
    Description string
    The description for a webhook.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags for the webhook.
    BranchName string
    The name for a branch that is part of an Amplify app.
    AppId string
    The unique ID for an Amplify app.
    Description string
    The description for a webhook.
    Tags TagArgs
    Tags for the webhook.
    branch_name string
    The name for a branch that is part of an Amplify app.
    app_id string
    The unique ID for an Amplify app.
    description string
    The description for a webhook.
    tags list(object)
    Tags for the webhook.
    branchName String
    The name for a branch that is part of an Amplify app.
    appId String
    The unique ID for an Amplify app.
    description String
    The description for a webhook.
    tags List<Tag>
    Tags for the webhook.
    branchName string
    The name for a branch that is part of an Amplify app.
    appId string
    The unique ID for an Amplify app.
    description string
    The description for a webhook.
    tags Tag[]
    Tags for the webhook.
    branch_name str
    The name for a branch that is part of an Amplify app.
    app_id str
    The unique ID for an Amplify app.
    description str
    The description for a webhook.
    tags Sequence[TagArgs]
    Tags for the webhook.
    branchName String
    The name for a branch that is part of an Amplify app.
    appId String
    The unique ID for an Amplify app.
    description String
    The description for a webhook.
    tags List<Property Map>
    Tags for the webhook.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) for the webhook.
    Id string
    The provider-assigned unique ID for this managed resource.
    WebhookId string
    The unique ID for a webhook.
    WebhookUrl string
    The URL of the webhook.
    Arn string
    The Amazon Resource Name (ARN) for the webhook.
    Id string
    The provider-assigned unique ID for this managed resource.
    WebhookId string
    The unique ID for a webhook.
    WebhookUrl string
    The URL of the webhook.
    arn string
    The Amazon Resource Name (ARN) for the webhook.
    id string
    The provider-assigned unique ID for this managed resource.
    webhook_id string
    The unique ID for a webhook.
    webhook_url string
    The URL of the webhook.
    arn String
    The Amazon Resource Name (ARN) for the webhook.
    id String
    The provider-assigned unique ID for this managed resource.
    webhookId String
    The unique ID for a webhook.
    webhookUrl String
    The URL of the webhook.
    arn string
    The Amazon Resource Name (ARN) for the webhook.
    id string
    The provider-assigned unique ID for this managed resource.
    webhookId string
    The unique ID for a webhook.
    webhookUrl string
    The URL of the webhook.
    arn str
    The Amazon Resource Name (ARN) for the webhook.
    id str
    The provider-assigned unique ID for this managed resource.
    webhook_id str
    The unique ID for a webhook.
    webhook_url str
    The URL of the webhook.
    arn String
    The Amazon Resource Name (ARN) for the webhook.
    id String
    The provider-assigned unique ID for this managed resource.
    webhookId String
    The unique ID for a webhook.
    webhookUrl String
    The URL of the webhook.

    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

    Package Details

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

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

    Viewing docs for AWS Cloud Control v1.76.0
    published on Monday, Aug 24, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial