Event Destinations v2

Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints and Amazon EventBridge. Event destinations support receiving thin events and snapshot events.

Learn more about calling API v2 endpoints.

Was this section helpful? Yes No

Create an Event Destination

POST / v2 / core / event_destinations

Update an Event Destination

POST / v2 / core / event_destinations /:id

Retrieve an Event Destination

GET / v2 / core / event_destinations /:id

List Event Destinations

GET / v2 / core / event_destinations

Delete an Event Destination

DELETE / v2 / core / event_destinations /:id

Disable an Event Destination

POST / v2 / core / event_destinations /:id / disable

Enable an Event Destination

POST / v2 / core / event_destinations /:id / enable

The Event Destination object v2

Attributes

• id string Unique identifier for the object.
• object string, 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 _ eventbridge nullable object Amazon EventBridge configuration.
• azure _ event _ grid nullable object Azure Event Grid configuration.
• created timestamp Time at which the object was created.
• description string An optional description of what the event destination is used for.
• enabled _ events array of strings The list of events to enable for this endpoint.
• event _ payload enum Payload type of events being subscribed to. Possible enum values snapshot Events from v1 APIs. thin Events from v2 APIs.
• events _ from nullable 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.
• livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• metadata nullable map Metadata.
• name string Event destination name.
• snapshot _ api _ version nullable string If using the snapshot event payload, the API version events are rendered as.
• status enum Status. It can be set to either enabled or disabled. Possible enum values disabled Event destination is disabled. enabled Event destination is enabled.
• status _ details nullable object Additional information about event destination status.
• type enum Event destination type. Possible enum values amazon_eventbridge Amazon EventBridge. azure_event_grid Azure Event Grid. webhook_endpoint Webhook endpoint.
• updated timestamp Time at which the object was last updated.
• webhook _ endpoint nullable object Webhook endpoint configuration.

The Event Destination object

Create an Event Destination v2

POST / v2 / core / event_destinations

Create a new event destination.

Learn more about calling API v2 endpoints.

Parameters

• enabled _ events array of strings Required The list of events to enable for this endpoint.
• event _ payload enum Required Payload type of events being subscribed to. Possible enum values snapshot Events from v1 APIs. thin Events from v2 APIs.
• name string Required Event destination name.
• type enum Required Event destination type. Possible enum values amazon_eventbridge Amazon EventBridge. azure_event_grid Azure Event Grid. webhook_endpoint Webhook endpoint.
• amazon _ eventbridge object Amazon EventBridge configuration.
• azure _ event _ grid object Azure Event Grid configuration.
• description string An optional description of what the event destination is used for.
• events _ from 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.
• include array of enums Additional fields to include in the response. Possible enum values webhook_endpoint.signing_secret Include parameter to expose webhook_endpoint.signing_secret. webhook_endpoint.url Include parameter to expose webhook_endpoint.url.
• metadata map Metadata.
• snapshot _ api _ version string If using the snapshot event payload, the API version events are rendered as.
• webhook _ endpoint object Webhook endpoint configuration.

Returns

Returns an Event Destination object.

Error Codes

400 expired _ azure _ partner _ authorization

Error returned when a user tries to create an event destination with an expired Azure partner authorization.

400 invalid _ azure _ partner _ authorization

Error returned when a user tries to create an event destination without an Azure partner authorization.

400 invalid _ azure _ partner _ configuration

Error returned when no valid partner configuration is found using the user provided Azure subscription ID and Azure resource group name.

409 idempotency _ error

An idempotent retry occurred with different request parameters.

Response