WebhookEndpoint

Stripe 0.3.0, Aug 14 26

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Create WebhookEndpoint Resource

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

Constructor syntax

new WebhookEndpoint(name: string, args: WebhookEndpointArgs, opts?: CustomResourceOptions);

@overload
def WebhookEndpoint(resource_name: str,
                    args: WebhookEndpointArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def WebhookEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    enabled_events: Optional[Sequence[str]] = None,
                    url: Optional[str] = None,
                    api_version: Optional[str] = None,
                    connect: Optional[bool] = None,
                    description: Optional[str] = None,
                    metadata: Optional[Mapping[str, str]] = None)

func NewWebhookEndpoint(ctx *Context, name string, args WebhookEndpointArgs, opts ...ResourceOption) (*WebhookEndpoint, error)

public WebhookEndpoint(string name, WebhookEndpointArgs args, CustomResourceOptions? opts = null)

public WebhookEndpoint(String name, WebhookEndpointArgs args)
public WebhookEndpoint(String name, WebhookEndpointArgs args, CustomResourceOptions options)

type: stripe:WebhookEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "stripe_webhook_endpoint" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args WebhookEndpointArgs: 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 WebhookEndpointArgs: 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 WebhookEndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WebhookEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WebhookEndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var webhookEndpointResource = new Stripe.WebhookEndpoint("webhookEndpointResource", new()
{
    EnabledEvents = new[]
    {
        "string",
    },
    Url = "string",
    ApiVersion = "string",
    Connect = false,
    Description = "string",
    Metadata = 
    {
        { "string", "string" },
    },
});

example, err := stripe.NewWebhookEndpoint(ctx, "webhookEndpointResource", &stripe.WebhookEndpointArgs{
	EnabledEvents: pulumi.StringArray{
		pulumi.String("string"),
	},
	Url:         pulumi.String("string"),
	ApiVersion:  pulumi.String("string"),
	Connect:     pulumi.Bool(false),
	Description: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

resource "stripe_webhook_endpoint" "webhookEndpointResource" {
  lifecycle {
    create_before_destroy = true
  }
  enabled_events = ["string"]
  url            = "string"
  api_version    = "string"
  connect        = false
  description    = "string"
  metadata = {
    "string" = "string"
  }
}

var webhookEndpointResource = new WebhookEndpoint("webhookEndpointResource", WebhookEndpointArgs.builder()
    .enabledEvents("string")
    .url("string")
    .apiVersion("string")
    .connect(false)
    .description("string")
    .metadata(Map.of("string", "string"))
    .build());

webhook_endpoint_resource = stripe.WebhookEndpoint("webhookEndpointResource",
    enabled_events=["string"],
    url="string",
    api_version="string",
    connect=False,
    description="string",
    metadata={
        "string": "string",
    })

const webhookEndpointResource = new stripe.WebhookEndpoint("webhookEndpointResource", {
    enabledEvents: ["string"],
    url: "string",
    apiVersion: "string",
    connect: false,
    description: "string",
    metadata: {
        string: "string",
    },
});

type: stripe:WebhookEndpoint
properties:
    apiVersion: string
    connect: false
    description: string
    enabledEvents:
        - string
    metadata:
        string: string
    url: string

WebhookEndpoint 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 WebhookEndpoint resource accepts the following input properties:

EnabledEvents List<string>: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
Url string: The URL of the webhook endpoint.
ApiVersion string: The API version events are rendered as for this webhook endpoint.
Connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
Description string: An optional description of what the webhook is used for.
Metadata Dictionary<string, string>: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

EnabledEvents []string: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
Url string: The URL of the webhook endpoint.
ApiVersion string: The API version events are rendered as for this webhook endpoint.
Connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
Description string: An optional description of what the webhook is used for.
Metadata map[string]string: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

enabled_events list(string): The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
url string: The URL of the webhook endpoint.
api_version string: The API version events are rendered as for this webhook endpoint.
connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
description string: An optional description of what the webhook is used for.
metadata map(string): Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

enabledEvents List<String>: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
url String: The URL of the webhook endpoint.
apiVersion String: The API version events are rendered as for this webhook endpoint.
connect Boolean: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
description String: An optional description of what the webhook is used for.
metadata Map<String,String>: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

enabledEvents string[]: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
url string: The URL of the webhook endpoint.
apiVersion string: The API version events are rendered as for this webhook endpoint.
connect boolean: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
description string: An optional description of what the webhook is used for.
metadata {[key: string]: string}: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

enabled_events Sequence[str]: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
url str: The URL of the webhook endpoint.
api_version str: The API version events are rendered as for this webhook endpoint.
connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
description str: An optional description of what the webhook is used for.
metadata Mapping[str, str]: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

enabledEvents List<String>: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
url String: The URL of the webhook endpoint.
apiVersion String: The API version events are rendered as for this webhook endpoint.
connect Boolean: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
description String: An optional description of what the webhook is used for.
metadata Map<String>: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Outputs

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

Application string: The ID of the associated Connect application.
Created double: Time at which the object was created. Measured in seconds since the Unix epoch.
Id string: The provider-assigned unique ID for this managed resource.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
Secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
Status string: The status of the webhook. It can be enabled or disabled.

Application string: The ID of the associated Connect application.
Created float64: Time at which the object was created. Measured in seconds since the Unix epoch.
Id string: The provider-assigned unique ID for this managed resource.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Object string: String representing the object's type. Objects of the same type share the same value.
Secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
Status string: The status of the webhook. It can be enabled or disabled.

application string: The ID of the associated Connect application.
created number: Time at which the object was created. Measured in seconds since the Unix epoch.
id string: The provider-assigned unique ID for this managed resource.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status string: The status of the webhook. It can be enabled or disabled.

application String: The ID of the associated Connect application.
created Double: Time at which the object was created. Measured in seconds since the Unix epoch.
id String: The provider-assigned unique ID for this managed resource.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
secret String: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status String: The status of the webhook. It can be enabled or disabled.

application string: The ID of the associated Connect application.
created number: Time at which the object was created. Measured in seconds since the Unix epoch.
id string: The provider-assigned unique ID for this managed resource.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object string: String representing the object's type. Objects of the same type share the same value.
secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status string: The status of the webhook. It can be enabled or disabled.

application str: The ID of the associated Connect application.
created float: Time at which the object was created. Measured in seconds since the Unix epoch.
id str: The provider-assigned unique ID for this managed resource.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object str: String representing the object's type. Objects of the same type share the same value.
secret str: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status str: The status of the webhook. It can be enabled or disabled.

application String: The ID of the associated Connect application.
created Number: Time at which the object was created. Measured in seconds since the Unix epoch.
id String: The provider-assigned unique ID for this managed resource.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
object String: String representing the object's type. Objects of the same type share the same value.
secret String: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status String: The status of the webhook. It can be enabled or disabled.

Look up Existing WebhookEndpoint Resource

Get an existing WebhookEndpoint 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>, state?: WebhookEndpointState, opts?: CustomResourceOptions): WebhookEndpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        application: Optional[str] = None,
        connect: Optional[bool] = None,
        created: Optional[float] = None,
        description: Optional[str] = None,
        enabled_events: Optional[Sequence[str]] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        object: Optional[str] = None,
        secret: Optional[str] = None,
        status: Optional[str] = None,
        url: Optional[str] = None) -> WebhookEndpoint

func GetWebhookEndpoint(ctx *Context, name string, id IDInput, state *WebhookEndpointState, opts ...ResourceOption) (*WebhookEndpoint, error)

public static WebhookEndpoint Get(string name, Input<string> id, WebhookEndpointState? state, CustomResourceOptions? opts = null)

public static WebhookEndpoint get(String name, Output<String> id, WebhookEndpointState state, CustomResourceOptions options)

resources:  _:    type: stripe:WebhookEndpoint    get:      id: ${id}

import {
  to = stripe_webhook_endpoint.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiVersion string: The API version events are rendered as for this webhook endpoint.
Application string: The ID of the associated Connect application.
Connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
Created double: Time at which the object was created. Measured in seconds since the Unix epoch.
Description string: An optional description of what the webhook is used for.
EnabledEvents List<string>: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Metadata Dictionary<string, string>: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Object string: String representing the object's type. Objects of the same type share the same value.
Secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
Status string: The status of the webhook. It can be enabled or disabled.
Url string: The URL of the webhook endpoint.

ApiVersion string: The API version events are rendered as for this webhook endpoint.
Application string: The ID of the associated Connect application.
Connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
Created float64: Time at which the object was created. Measured in seconds since the Unix epoch.
Description string: An optional description of what the webhook is used for.
EnabledEvents []string: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
Livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
Metadata map[string]string: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Object string: String representing the object's type. Objects of the same type share the same value.
Secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
Status string: The status of the webhook. It can be enabled or disabled.
Url string: The URL of the webhook endpoint.

api_version string: The API version events are rendered as for this webhook endpoint.
application string: The ID of the associated Connect application.
connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
created number: Time at which the object was created. Measured in seconds since the Unix epoch.
description string: An optional description of what the webhook is used for.
enabled_events list(string): The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata map(string): Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object string: String representing the object's type. Objects of the same type share the same value.
secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status string: The status of the webhook. It can be enabled or disabled.
url string: The URL of the webhook endpoint.

apiVersion String: The API version events are rendered as for this webhook endpoint.
application String: The ID of the associated Connect application.
connect Boolean: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
created Double: Time at which the object was created. Measured in seconds since the Unix epoch.
description String: An optional description of what the webhook is used for.
enabledEvents List<String>: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata Map<String,String>: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object String: String representing the object's type. Objects of the same type share the same value.
secret String: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status String: The status of the webhook. It can be enabled or disabled.
url String: The URL of the webhook endpoint.

apiVersion string: The API version events are rendered as for this webhook endpoint.
application string: The ID of the associated Connect application.
connect boolean: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
created number: Time at which the object was created. Measured in seconds since the Unix epoch.
description string: An optional description of what the webhook is used for.
enabledEvents string[]: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
livemode boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata {[key: string]: string}: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object string: String representing the object's type. Objects of the same type share the same value.
secret string: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status string: The status of the webhook. It can be enabled or disabled.
url string: The URL of the webhook endpoint.

api_version str: The API version events are rendered as for this webhook endpoint.
application str: The ID of the associated Connect application.
connect bool: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
created float: Time at which the object was created. Measured in seconds since the Unix epoch.
description str: An optional description of what the webhook is used for.
enabled_events Sequence[str]: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
livemode bool: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata Mapping[str, str]: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object str: String representing the object's type. Objects of the same type share the same value.
secret str: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status str: The status of the webhook. It can be enabled or disabled.
url str: The URL of the webhook endpoint.

apiVersion String: The API version events are rendered as for this webhook endpoint.
application String: The ID of the associated Connect application.
connect Boolean: Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.
created Number: Time at which the object was created. Measured in seconds since the Unix epoch.
description String: An optional description of what the webhook is used for.
enabledEvents List<String>: The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.
livemode Boolean: If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata Map<String>: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object String: String representing the object's type. Objects of the same type share the same value.
secret String: The endpoint's secret, used to generate webhook signatures. Only returned at creation.
status String: The status of the webhook. It can be enabled or disabled.
url String: The URL of the webhook endpoint.

Package Details

Repository: stripe stripe/terraform-provider-stripe
License
Notes: This Pulumi package is based on the stripe Terraform Provider.

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

Schema (JSON)

stripe/terraform-provider-stripe

stripe.WebhookEndpoint

On this page

On this page

Create WebhookEndpoint Resource

Constructor syntax

Parameters

Constructor example

WebhookEndpoint Resource Properties

Inputs

Outputs

Look up Existing WebhookEndpoint Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

stripe.WebhookEndpoint

On this page

On this page

Create WebhookEndpoint Resource

Constructor syntax

Parameters

Constructor example

WebhookEndpoint Resource Properties

Inputs

Outputs

Look up Existing WebhookEndpoint Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.