Listen for events

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

1. Handle webhook events in your app’s back end.
2. Register a webhook endpoint in the Stripe Dashboard, and select Listen to events on Connected accounts.
3. 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.
4. Add the required permissions to your app by running stripe apps grant permission for each one.
   Command Line

   stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"

   Replace:
   • PERMISSION_NAME with the permission name.
   • EXPLANATION 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:

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:

{
  "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"
    }
  ],
}

Listen for events on your account

To receive events for an app that’s private to users on your account only:

1. Handle webhook events in your app’s back end.
2. Register a webhook endpoint in the Stripe Dashboard.

Receive event notifications about your app

Listen for events (such as user installs or uninstalls) on your Stripe app using incoming webhooks so your integration can automatically trigger reactions in your back end such as:

• Creating user accounts
• Updating permissions
• Disabling a user’s account and removing data

In addition to the types of events Stripe supports, Stripe Apps also supports the following events:

Test webhooks locally

You can test webhooks locally for:

• An app that’s only available to all users on your account and listens to events on your own account
• An app that’s available on the Stripe App Marketplace and listens to events on accounts that have installed your app

To test webhooks locally:

1. Install the Stripe CLI.

2. Authenticate your account:

   Command Line

   stripe login

3. Open two terminal windows:

   • In one terminal window, Set up event forwarding:

     Public listing on App Marketplace

     Private to your account only

     Command Line

     stripe listen --forward-connect-to localhost:{{PORT}}/webhook

   • In the other terminal window, Trigger events to test your webhooks integration:

     Public listing on App Marketplace

     Private to your account only

     Command Line

     stripe trigger --stripe-account {{EVENT_NAME}}

For more information, see our docs on testing a webhook endpoint.