Attributes

• idstring

  Unique identifier for the object.

• objectstring, value is "v2.core.event_destination"

  String representing the object’s type. Objects of the same type share the same value of the object field.

• amazon_eventbridgenullable object

  Configuration for delivering events through an Amazon EventBridge partner event source.

  Show child attributes

• azure_event_gridnullable object

  Configuration for delivering events through an Azure Event Grid partner topic.

  Show child attributes

• createdtimestamp

  The time when the destination was created.

• descriptionstring

  An optional user-defined description of the destination’s purpose.

• enabled_eventsarray of strings

  The list of event types enabled for delivery to this destination.

• event_payloadenum

  Whether to deliver as snapshot or thin events.

  Possible enum values

  snapshot Events that contain full resource objects in the delivered payload, rendered using a specified API version.

  thin A lightweight event notification with an unversioned payload. It identifies the related Stripe resource so you can retrieve the complete event or the resource’s current state. This reduces coupling to API-versioned object snapshots and makes event handlers easier to maintain.

• events_fromnullable array of strings

  Specifies which accounts’ events route to this destination. @self: Receive events from the account that owns the event destination. @accounts: Receive events emitted from other accounts you manage which includes your v1 and v2 accounts. @organization_members: Receive events from accounts directly linked to the organization. @organization_members/@accounts: Receive events from all accounts connected to any platform accounts in the organization.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• metadatanullable map

  User-defined key/value data for the destination; it has no effect on event matching or delivery.

• namestring

  A user-defined label for identifying the destination in Stripe.

• snapshot_api_versionnullable string

  For snapshot events only, the Stripe API version used to render event objects. You can’t change this value after you create the event destination. Thin events are not pinned to an API version.

• statusenum

  Whether Stripe currently attempts delivery. Stripe attempts delivery to enabled destinations when their provider configuration is active; disabled destinations do not receive delivery attempts.

  Possible enum values

  disabled Event destination is disabled.

  enabled Event destination is enabled.

• status_detailsnullable object

  Additional lifecycle context for the destination status, when available.

  Show child attributes

• typeenum

  The delivery transport. Chosen when the destination is created and cannot be changed by update.

  Possible enum values

  amazon_eventbridge Deliver matching events through a Stripe partner event source in Amazon EventBridge.

  azure_event_grid Deliver matching events through a Stripe partner topic in Azure Event Grid.

  webhook_endpoint Deliver matching events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

• updatedtimestamp

  The time when the destination object was last updated.

• webhook_endpointnullable object

  Configuration for delivering events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

  Show child attributes

Create a new event destination.

Parameters

• enabled_eventsarray of stringsRequired

  The list of event types enabled for delivery to this destination.

• event_payloadenumRequired

  Whether to deliver as snapshot or thin events.

  Possible enum values

  snapshot Events that contain full resource objects in the delivered payload, rendered using a specified API version.

  thin A lightweight event notification with an unversioned payload. It identifies the related Stripe resource so you can retrieve the complete event or the resource’s current state. This reduces coupling to API-versioned object snapshots and makes event handlers easier to maintain.

• namestringRequired

  A user-defined label for identifying the destination.

• typeenumRequired

  The delivery transport. Chosen when the destination is created and cannot be changed by update.

  Possible enum values

  amazon_eventbridge Deliver matching events through a Stripe partner event source in Amazon EventBridge.

  azure_event_grid Deliver matching events through a Stripe partner topic in Azure Event Grid.

  webhook_endpoint Deliver matching events to a webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

• amazon_eventbridgeobject

  AWS account and region where Stripe creates the EventBridge partner event source.

  Show child parameters

• azure_event_gridobject

  Azure subscription, resource group, and region where Stripe creates the partner topic.

  Show child parameters

• descriptionstring

  An optional user-defined description of the destination’s purpose.

• events_fromarray of strings

  The account or organization scopes that can supply events. Use this with enabled_events to define the subscription. @self: Receive events from the account that owns the event destination. @accounts: Receive events emitted from other accounts you manage, including your v1 and v2 accounts. @organization_members: Receive events from accounts directly linked to the organization. @organization_members/@accounts: Receive events from all accounts connected to any platform accounts in the organization.

• includearray of enums

  Include normally redacted webhook fields in the create response. Public API clients must include webhook_endpoint.signing_secret to receive the signing secret.

  Possible enum values

  webhook_endpoint.signing_secret Include webhook_endpoint.signing_secret in the create response. Public API clients cannot retrieve it later.

  webhook_endpoint.url Include the normally redacted webhook_endpoint.url in the create response.

• metadatamap

  User-defined key/value data for the destination.

• snapshot_api_versionstring

  For snapshot events only, the Stripe API version used to render event objects; do not provide this for thin events.

• webhook_endpointobject

  Delivery target for the webhook endpoint. Live mode requires HTTPS; sandbox mode also supports HTTP.

  Show child parameters