Connect-Webhooks

Stripe nutzt Webhooks, um Ihre Anwendung bei einem Ereignis in Ihrem Konto zu benachrichtigen. Alle Connect-Integrationen sollten einen Webhook-Endpoint einrichten, um auf Connect-Ereignisse aufmerksam gemacht zu werden.

Connect-Webhooks

Es gibt einige Arten von Webhooks:

• Account-Webhooks beziehen sich auf Aktivitäten in Ihrem eigenen Konto (zum Beispiel die meisten Anforderungen, die mit Ihren API-Schlüsseln und ohne Authentifizierung als anderes Stripe-Konto erfolgen). Dazu gehören alle Arten von Zahlungen, bis auf solche, die direkt für ein verbundenes Konto erfolgen.
• Connect-Webhooks beziehen sich auf Aktivitäten in einem beliebigen verbundenen Konto. Alle Ereignisse für das verbundene Konto werden an die Connect-Webhooks gesendet. Dazu gehört das wichtige Ereignis account.updated für verbundene Konten und Direct Charges.

Achten Sie beim Erstellen darauf, dass Ihr Webhook richtig konfiguriert wird, um Connect-Webhook-Ereignisse empfangen zu können. Diesen Schritt können Sie über die API erledigen, indem Sie den Connect-Parameter beim Erstellen des Webhook-Endpoints auf true festlegen, oder im Dashboard vornehmen.

Für Connect-Webhooks werden nur Test-Webhooks an Ihre Entwicklungs-Webhook-URLs gesendet. Allerdings werden sowohl Live- als auch Test-Webhooks an Ihre Produktions-Webhook-URLs gesendet. So können Sie in einer Produktionsanwendung sowohl Live- als auch Testtransaktionen durchführen. Daher empfehlen wir Ihnen, den Wert für den livemode zu überprüfen, wenn Sie einen Ereignis-Webhook erhalten, um zu wissen, welche Maßnahmen Nutzer/innen gegebenenfalls ergreifen sollten.

Wie in der Objektreferenz zu Ereignissen angegeben, enthält jedes Ereignis für ein verbundenes Konto auch eine Top-Level-Eigenschaft account. Sie identifiziert das Konto, an das der Webhook gesendet wird, und das data[object], zu dem es gehört. Da diese Objekte zu anderen Konten gehören, müssen Sie die API-Anfragen als das entsprechende verbundene Konto stellen, um auf sie zuzugreifen.

{
  "id": 
"{{EVENT_ID}}",
  "livemode": true,
  "object": "event",
  "type": "customer.created",
  "account": 
"{{CONNECTED_ACCOUNT_ID}}",
  "pending_webhooks": 2,
  "created": 1349654313,
  "data": {...}
}

Es gibt verschiedene Ereignisse im Zusammenhang mit Konten, für die Stripe eine solche Benachrichtigung empfiehlt:

# Using Sinatra.
require 'sinatra'
require 'stripe'

set :port, 4242

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_4eC39HqLyjWDarjtT1zdp7dc'

# If you are testing your webhook locally with the Stripe CLI you
# can find the endpoint's secret by running `stripe listen`
# Otherwise, find your endpoint's secret in your webhook settings in
# the Developer Dashboard
endpoint_secret = 'whsec_...'

post '/webhook' do
  payload = request.body.read
  sig_header = request.env['HTTP_STRIPE_SIGNATURE']

  event = nil

  # Verify webhook signature and extract the event.
  # See https://stripe.com/docs/webhooks#verify-events for more information.
  begin
    event = Stripe::Webhook.construct_event(
      payload, sig_header, endpoint_secret
    )
  rescue JSON::ParserError => e
    # Invalid payload.
    status 400
    return
  rescue Stripe::SignatureVerificationError => e
    # Invalid Signature.
    status 400
    return
  end

  if event['type'] == 'account.application.deauthorized'
    application = event['data']['object']
    connected_account_id = event['account']
    handle_deauthorization(connected_account_id, application)
  end

  status 200
end

def handle_deauthorization(connected_account_id, application)
  # Clean up account state.
  puts 'Connected account ID: ' + connected_account_id
  puts application.to_s
end

In der Regel empfehlen wir, dass Connect-Integrationen sich über die oben aufgeführten Ereignisse benachrichtigen lassen. Es gibt aber noch viele weitere Ereignistypen, die für Sie interessant sein könnten.

Webhooks lokal testen

Sie können die Stripe-CLI verwenden, um Webhooks lokal zu testen.

1. Falls noch nicht vorhanden, installieren Sie die Stripe-CLI auf Ihrem Rechner.

2. Melden Sie sich in Ihrem Stripe-Konto an und richten Sie die CLI ein, indem Sie in der Befehlszeile stripe login ausführen.

3. Lassen Sie Ihren lokalen Host ein simuliertes Ereignis in Ihrem verbundenen Konto empfangen, indem Sie in einem Terminalfenster stripe listen --forward-to localhost:{PORT}/webhook und in einem anderen stripe trigger {{EVENT_NAME}} ausführen.