Skip to content
Create account or Sign in
The Stripe Docs logo
/
Ask AI
Create accountSign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
APIs & SDKsHelp
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Essentials
SDKs
API
Testing
Stripe CLI
Stripe Projects
Tools
Stripe Dashboard
Workbench
Developers Dashboard
Stripe for Visual Studio Code
Terraform
Stripe Discord server
Features
Workflows
Batch jobs
Event destinations
    Integrate with events
    Amazon EventBridge
    Azure Event Grid
    Webhook endpoint
Stripe health alertsStripe SignalsFile uploads
AI solutions
Model Context ProtocolAgent skillsStripe Directory
Extend Stripe
Overview
Build Stripe apps
Use apps from Stripe
Build extensions
Custom objects
Security and privacy
Security
Activity logsStripebot web crawler
Privacy
Partners
Partner ecosystem
Partner certification
United States
English (United States)
  1. Home/
  2. Developer resources/
  3. Event destinations

Integrate with events

Send events from Stripe to webhook endpoints and cloud services.

Private preview

Thin events for API v1 resources are available in private preview. You can use them to streamline integration upgrades without changing your webhook configuration. Previously, thin events only supported API v2 resources. Learn more and request access.

Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints, Amazon EventBridge, and Azure Event Grid. You can receive events in either:

  • Self-contained snapshot events for a point-in-time view of your resources
  • Lightweight thin events to guarantee you always act on the most up-to-date data, which help simplify your integration upgrade process

Use cases

When building Stripe integrations, you might want your applications to receive events in real-time from your Stripe accounts, enabling your backend systems to respond and perform actions accordingly.

With an event destination, Stripe pushes real-time event data from your account, enabling you to run backend actions, such as:

  • Sending users a notification when a customer confirms a payment
  • Initiating an internal claims reconciliation process when a customer disputes a charge
  • Granting access to your user when they make successful recurring subscription payments

Supported destination types

Send events to an AWS account using Amazon EventBridge, an Azure subscription using Azure Event Grid, or deliver them to an HTTPS endpoint through webhook endpoints.

Events overview

When an event occurs, Stripe generates a new Event object. A single API request could result in the creation of multiple events. For example, creating a new subscription for a customer might result in customer.subscription.created and payment_intent.succeeded events. For programmatic integrations, we recommend that you configure an event destination to receive these events as they happen. The way the event is structured and delivered to your destination depends on the format you choose to receive.

We provide two versions of Event objects:

  • Thin events (v2): A thin event sends a lightweight notification that includes only limited information about the v2 Event object and the affected object. You can make a subsequent API call to fetch the complete Event object or related resource. Thin events are generated by API v2 endpoints . See a full list of thin events.
  • Snapshot events: A snapshot event sends a notification containing the complete Event object, which includes an eventually-consistent snapshot of the updated resource. Because this data can be stale by the time you process it, we recommend fetching the latest version of the resource from the API. Unlike thin event notifications, the delivered snapshot events are versioned, which requires you to manage versions both on your event destination and your client. These events are generated by both API v1 endpoints and API v2 endpoints. They include a previous_attributes property that indicates the change, if applicable. See a full list of snapshot events.

Choose a format

Use thin events when:

  • Data integrity is critical, and your application must act on the most up-to-date information.
  • You want to simplify versioning by managing upgrades only on the client-side.
  • You’re building a modern, type-safe application and want to take advantage of SDK typing benefits.

Use snapshot events when:

  • You need to audit the specific fields that have changed without making a subsequent API call.
  • Your integration requires a point-in-time view of the resource definition and can tolerate working with eventually-consistent data.

This table outlines high-level differences across thin events and snapshot events.

CharacteristicsSnapshot eventsThin events
Created byBoth API v1 and API v2 resource state changesAPI v2 resource state changes
Delivered payloadLarge: Includes a snapshot of the API object related to the eventSmall: Includes an ID of the API object related to the event in a lightweight event notification
Accessing additional data to process event.Fetch the latest object definition from the API. The object definition in the event payload might be outdated by the time you process the event.Fetch the latest object from the API or retrieve the complete event from v2/events. The complete event payload can include extra details about the event. For example, the payload for a v1.billing.meter.error_report_triggered event includes information about the types and frequency of errors raised.
SDK typingUntypedTyped
VersioningVersioned by API versionUnversioned, allowing you to upgrade your integration without changing your webhook endpoint configuration
API to view eventsEvents v1 APIEvents v2 API

If you use Accounts v2, you might listen to both snapshot and thin events.

Example thin event notification payload

The following example shows a v2.core.account.updated thin event notification. The id property in the notification payload contains the ID of the associated Event object. The reason hash contains information about what triggered the event, and the related_object hash includes information about the associated object, including its ID.

To access additional event properties like data and changes, use the fetchEvent() method to retrieve the complete Event object. You can also retrieve the associated object using the fetchRelatedObject() method.

{ "id": "evt_test_65UIRNU7G1XbhCfOim416TgmEI4ASQ3jHxXt8RFwXoeVwO", "object": "v2.core.event", "type": "v2.core.account.updated", "livemode": false, "created": "2026-03-09T13:00:28.435Z", "context": null, "reason": { "type": "request", "request": { "id": "req_v2y9y15XqG3Futmjg", "idempotency_key": "ik_TgmEI3jHxXt8RFw4jS7ve2QcAReDQWBjPAkAEUm" } }, "related_object": { "id": "acct_1T93Q4Pmpb34Vto6", "type": "v2.core.account", "url": "/v2/core/accounts/acct_1T93Q4Pmpb34Vto6" } }

Example snapshot event payload

View the following example of an setup_intent.created snapshot event, which includes the object definition as it was when the event was raised:

{ "id": "evt_1NG8Du2eZvKYlo2CUI79vXWy", "object": "event", "api_version": "2019-02-19", "created": 1686089970,

Using thin events

Integrate with thin events by using the event notification sent to your destination to retrieve more details from the API.

Processing the event notification

The initial notification contains minimal data. Choose one of three approaches when processing the event notification, depending on what information your integration requires:

  1. Retrieve the complete event: Use the fetchEvent() method to retrieve the complete Event object when you need more information than the related object’s latest state provides. The complete event object can include two types of additional data:
    • Contextual information about the event itself, available in the data hash. For example, a v1.billing.meter.error_report_triggered event includes details about the types and summary of validation errors in this field.
    • The previous values of any attributes that changed on the resource, available in the changes hash.

The following table details the additional data available in the complete event object compared to the initial notification:

Property nameEvent notificationEvent
Event type
Related resource ID
Event ID
Created timestamp
Reason
Changes
Data
  1. Retrieve the latest state of the related object: Use the fetchRelatedObject() method to retrieve the latest version of the object associated with the event. For example, if you receive a v1.billing.meter.error_report_triggered event, fetchRelatedObject() retrieves the meter object that triggered an error report.
  2. Process the notification immediately: If the event type and resource ID in the notification are sufficient for your use case, you can process it without making an additional API call.

The following example shows how to retrieve the latest state of the related object directly from the event notification, without making an additional API call to fetch the event:

Java
Node.js
Python
.NET
Ruby
PHP
Go
No results
com.stripe.model.v2.core.EventNotification eventNotification = client.parseEventNotification(payload, signatureHeader, endpointSecret); if (eventNotification instanceof V1BillingMeterErrorReportTriggeredEventNotification) { V1BillingMeterErrorReportTriggeredEventNotification notif = (V1BillingMeterErrorReportTriggeredEventNotification) eventNotification; // fetchRelatedObject() makes one network request to fetch the latest version // of the object associated with this event (a Meter, in this case). // No API call to retrieve the full Event is needed. Meter meter = notif.fetchRelatedObject(); }

The following example shows how to fetch the complete Event object when your integration requires additional data, such as the data hash with contextual information or the changes hash with previous attribute values:

Java
Node.js
Python
.NET
Ruby
PHP
Go
No results
com.stripe.model.v2.core.EventNotification eventNotification = client.parseEventNotification(payload, signatureHeader, endpointSecret); if (eventNotification instanceof V1BillingMeterErrorReportTriggeredEventNotification) { V1BillingMeterErrorReportTriggeredEventNotification notif = (V1BillingMeterErrorReportTriggeredEventNotification) eventNotification; // Use fetchEvent() when you need additional data in the Event object, // such as the "data" hash with contextual info or the "changes" hash // with previous attribute values. com.stripe.model.v2.core.Event event = notif.fetchEvent(); if (event instanceof V1BillingMeterErrorReportTriggeredEvent) { V1BillingMeterErrorReportTriggeredEvent typedEvent = (V1BillingMeterErrorReportTriggeredEvent) event; String summary = typedEvent.getData().getDeveloperMessageSummary(); } }

SDK typing

Thin events and their notifications are fully typed in the SDKs.

  • Event notification: The initial, lightweight payload delivered to your event destination is typed as {EventType}EventNotification.
  • Event: After you retrieve the complete event from the API using fetchEvent(), the resulting object is typed as {EventType}Event.

Event permissions

To view an event in the Dashboard, assign the Admin or Developer role to your user account. To retrieve an event using the API, use either a secret API key, which allows you to view all event types by default, or a restricted API key with Read access enabled for the specific event type’s resource. For example, you can grant Read access to payment_intent resources on your restricted API key to programmatically retrieve payment_intent.succeeded events.

Event retention

In the Events tab in Workbench, you can access events within the last 13 months:

  • For events less than 15 days old, you can view the full event payload, see the delivery attempts, and manually resend these events.
  • For events 16-30 days old, you can access the full event payload, but you can’t resend them or view delivery attempts.
  • For events older than 30 days, you can only see a summary view, which includes truncated fields of the original event data. Resending and viewing delivery attempts aren’t available for these events.

Use the Retrieve event and List events APIs to access events with their full payload from the past 30 days.

Event destination limits

You can register a maximum of 16 event destinations in each livemode or sandbox account. When registering a snapshot event destination with a version different from your merchant’s default version, you can register up to three uniquely versioned snapshot event destinations.

Manage an event destination

To create, delete, and update an event destination in the Dashboard, open the Webhooks tab in Workbench or use the event destinations API.

Disable an event destination

You can disable an event destination. After you disable it, Stripe stops sending any events to that destination. After you re-enable a destination, Stripe resumes sending events to it.

Was this page helpful?
YesNo
  • Need help? Contact Support.
  • Chat with Stripe developers on Discord.
  • Check out our changelog.
  • Questions? Contact Sales.
  • LLM? Read llms.txt.
  • Powered by Markdoc
On this page