Ereignisse überwachen

Apps können Webhooks verwenden, um Benachrichtigungen über Ereignisse in den Konten ihrer Nutzer/innen zu erhalten. Dadurch können App-Entwickler/innen bei Bedarf Informationen synchronisieren und Aktionen in der App auslösen.

Loslegen

1. Verarbeiten Sie Webhook-Ereignisse im Backend Ihrer App.
2. Registrieren Sie einen Webhook-Endpoint im Stripe-Dashboard und wählen Sie die Option Ereignisse von verbundenen Konten überwachen aus.
3. Recommended Registrieren Sie einen Test-Webhook-Endpoint im Stripe Dashboard. Sie können Apps im Live-Modus, Test-Modus oder in einer Sandbox installieren. Wir empfehlen außerdem, einen Test-Endpoint für die Verarbeitung von Testereignissen einzurichten.
4. Fügen Sie Ihrer App die erforderlichen Berechtigungen hinzu, indem Sie stripe apps grant permission für jede App ausführen.
   Command Line

   stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"

   Ersetzen:
   • PERMISSION_NAME mit dem Berechtigungsnamen.
   • EXPLANATION mit einer Erklärung für die Aktivierung des Zugriffs. Nutzer/innen sehen diese Erklärung, wenn sie Ihre App installieren.

Sie müssen die Berechtigung event_read sowie alle Berechtigungen hinzufügen, die mit den spezifischen Ereignissen verknüpft sind, die Sie verarbeiten möchten. Weitere Informationen darüber, welche Berechtigungen für ein bestimmtes Ereignis erforderlich sind, finden Sie unter Ereignisberechtigungen.

Wenn Sie beispielsweise die Ereignisse payment_intent.succeeded und setup_intent.succeeded verarbeiten möchten, führen Sie die folgenden Befehle aus:

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"

Nachdem Sie diese Befehle ausgeführt haben, sieht Ihre App-Manifestdatei möglicherweise wie folgt aus:

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

Ereignisse in Ihrem Konto überwachen

So empfangen Sie Ereignisse für eine App, die nur für Nutzer/innen Ihres Kontos bestimmt ist:

1. Verarbeiten Sie Webhook-Ereignisse im Backend Ihrer App.
2. Registrieren Sie einen Webhook-Endpoint im Stripe-Dashboard.

Ereignisbenachrichtigungen über Ihre App empfangen

Überwachen Sie Ihre Stripe-App mithilfe eingehender Webhooks auf Ereignisse (z. B. Installationen oder Deinstallationen durch Nutzer/innen), damit Ihre Integration automatisch Reaktionen in Ihrem Backend auslösen kann, wie z. B.:

• Nutzerkonten erstellen
• Berechtigungen aktualisieren
• Konto eines/einer Nutzers/in deaktivieren und Daten entfernen

Zusätzlich zu den Ereignistypen, die Stripe unterstützt, unterstützt Stripe Apps auch die folgenden Ereignisse:

Webhooks lokal testen

Sie können Webhooks lokal für Folgendes testen:

• Eine App, die nur für alle Nutzer/innen Ihres Kontos verfügbar ist und Ereignisse Ihres eigenen Kontos überwacht
• Eine App, die im Stripe App Marketplace verfügbar ist und Ereignisse für Konten überwacht, die Ihre App installiert haben

So testen Sie Webhooks lokal:

1. Installieren Sie die Stripe-CLI.

2. Authentifizieren Sie Ihr Konto:

   Command Line

   stripe login

3. Öffnen Sie zwei Terminal-Fenster:

   • In einem Terminal-Fenster können Sie die Ereignisweiterleitung einrichten:

     Öffentlicher Eintrag im App-Marktplatz

     Nur privat für Ihr Konto

     Command Line

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

   • In dem anderen Terminal-Fenster können Sie Ereignisse zum Testen Ihrer Webhooks-Integration auslösen:

     Öffentlicher Eintrag im App-Marktplatz

     Nur privat für Ihr Konto

     Command Line

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

Weitere Informationen finden Sie in unserer Dokumentation zum Testen eines Webhook-Endpoints.