Process incoming webhooks with event notification handlers
In each of our SDKs, we’ve created a specialized class that encapsulates the mechanics of parsing and validating a Stripe webhook. Event notification handlers take care of validating, parsing, and routing incoming thin event notifications to your business logic. They also provide authoring-time validation for your code, such as strong typing for all event data and typo protection for every event type.
To use this feature, you must write a function for each thin event type you want to handle. After you register these functions on the handler, the SDK calls them when you receive the corresponding event notification.
Before you begin
You must use one of the following SDK versions (or higher) to use event notification handlers.
| Language | GA | Public Preview | Private Preview |
|---|---|---|---|
| Python | v15.6.0 | v14.2.0b1 | v15.2.0a3 |
| Ruby | v19.6.0 | v18.2.0-beta.1 | v19.2.0-alpha.3 |
| PHP | v21.3.0 | v19.2.0-beta.1 | v20.2.0-alpha.4 |
| Go | v86.4.0 | v84.2.0-beta.1 | v85.2.0-alpha.3 |
| Node | v22.6.0 | v20.2.0-beta.1 | v22.2.0-alpha.4 |
| .NET | v52.4.0 | v50.2.0-beta.1 | v51.2.0-alpha.3 |
| Java | v33.4.0 | v31.2.0-beta.1 | v32.2.0-alpha.3 |
Write a fallback callback
Write a function that runs whenever a dedicated callback hasn’t been registered for a specific event type. You call it with the EventNotification, a StripeClient, and additional information about the event.
This function could log the fact that you received an unexpected event or give you an error to alert you to the unexpected state. You can also add business logic in this function if you’re handling events that your SDK doesn’t have types for.
Select a language
Python
Java
Ruby
PHP
Go
Node
.NET
No results
def fallback_callback(notif: EventNotification, client: StripeClient, details: UnhandledNotificationDetails):
print(f'Got an unhandled event of type {notif.type}!')
As part of your migration, consider moving all of your webhook endpoint code into this function. Then, you can migrate individual event types to their own functions.
Initialize your handler
In your webhook endpoint, initialize an EventNotificationHandler, passing it your fallback callback. There’s a convenience method on StripeClient to simplify this step.
If you’re writing a traditional webhook endpoint, you must pass your webhook secret to the handler constructor so the SDK can verify the authenticity of the webhook.
Select a language
Python
Java
Ruby
PHP
Go
Node
.NET
No results
client = StripeClient(api_key)
handler = client.notification_handler(webhook_secret, fallback_callback)
Write & register a callback
Next, write a function responsible for handling a specific event type. It uses the event types released with the Clover API version in September 2025.
Your callback will receive the event notification cast to the correct class. You’ll also get a StripeClient, bound to the context of the notification, which makes it easy to make additional API calls without juggling account ids.
Select a language
Python
Java
Ruby
PHP
Go
Node
.NET
No results
# can be anywhere in your codebase
@handler.on_v1_billing_meter_error_report_triggered
def handle_meter_error(
notif: V1BillingMeterErrorReportTriggeredEventNotification,
client: StripeClient,
):
event = notif.fetch_event()
print(f"Err! No meter found: {event.data.developer_message_summary}")
You can register zero or more callbacks. If you don’t register any, all events will be routed to your fallback callback.
Process events
Send incoming POST bodies into the handler. This replaces most of the original code in your webhook endpoint.
If you’re writing a traditional webhook endpoint, you must pass the Stripe-Signature header to .handle() so the SDK can verify the authenticity of the webhook.
Select a language
Python
Java
Ruby
PHP
Go
Node
.NET
No results
@app.route("/webhooks", methods=["POST"])
def webhook():
webhook_body = request.data
sig_header = request.headers.get("Stripe-Signature")
try:
handler.handle(webhook_body, sig_header)
return jsonify(success=True), 200
except Exception as e:
return jsonify(error=str(e)), 400
How it works
Internally, handling an event follows a few steps (shown in more detail above):
- Parse and validate the incoming event.
- Determine which callback you need to invoke.
- Run that callback with the correctly typed EventNotification class.
Familiarize yourself with the following features.
The preHandle method
Event notification handlers have a preHandle method designed around two main use cases:
- Calling a function before invoking any callbacks (such as a logger).
- Halting the processing of an event based on the content of that event. Use this for deduplicating events
You register the pre-handle callback in the same way as event-specific callbacks. And as with other callbacks, you invoke it with the parsed EventNotification class and a StripeClient instance bound to the event’s context
Select a language
Python
Java
Ruby
PHP
Go
Node
.NET
No results
# example for testing; use something more durable for production
processed_event_ids = set()
@handler.pre_handle
def log_and_dedup(notif: EventNotification, client: StripeClient) -> bool:
# log every incoming event
print(f'Starting {notif.id}')
# ignore duplicates...
if notif.id in processed_event_ids:
print(f"Already processed {notif.id}, skipping.")
return False
processed_event_ids.add(notif.id)
# ... or event types you don't care about
if notif.type == 'some.ignored.event':
return False
return True
The pre-handle callback must return a bool. Returning true means event handling continues and an event-specific callback (or your fallback) is invoked as normal. Returning false causes execution to stop (without error).
Error handling
The event notification handler does no additional error handling or suppressing. Any SDK error (such as each language’s SignatureVerificationError) or error from your callbacks comes from the .handle(...) function.
