Listen for events

Listen for events on your installed users accounts

Apps can use Webhooks to get alerts about events happening on their users’ accounts. This helps app developers keep information in sync or trigger actions within their app when something changes.

Get started

Handle webhook events in your app’s back end .
Register a webhook endpoint in the Stripe Dashboard, and select Listen to events on Connected accounts .
Recommended Register a test webhook endpoint in the Stripe Dashboard. You can install apps in live mode, test mode , or a sandbox . We also recommend setting up a test endpoint to handle test events.
Add the required permissions to your app by running stripe apps grant permission for each one. Command Line stripe apps grant permission "the related setting" "the related setting" Replace:

the related setting _ the related setting with the permission name.
the related setting with an explanation for enabling access. Users see this explanation when they install your app.

You must add the event_read permission, plus any permissions associated with the specific events you want to handle. For information about which permissions a particular event requires, see Event permissions.

For example, if you want to handle the payment_intent.succeeded and setup_intent.succeeded events, run the following commands:

Command Line

stripe apps grant permission "event_read" "Read webhook event data"
stripe apps grant permission "checkout_session_read" "Read Checkout Session data in webhook events"
stripe apps grant permission "payment_intent_read" "Read PaymentIntent data in webhook events"
stripe apps grant permission "setup_intent_read" "Read SetupIntent data in webhook events"

After you run those commands, your app manifest file might look like this:

stripe-app.json

{
 "id": "com.example.app",
 "version": "1.2.3",
 "name": "Example App",
 "icon": "./example_icon_32.png",
 "permissions": [
 {
 "permission": "event_read",
 "purpose": "Read webhook event data"
 },
 {
 "permission": "checkout_session_read",
 "purpose": "Read Checkout Session data in webhook events"
 },
 {
 "permission": "payment_intent_read",
 "purpose": "Read PaymentIntent data in webhook events"
 },
 {
 "permission": "setup_intent_read",
 "purpose": "Read SetupIntent data in webhook events"
 }
 ]
}