So verbinden Sie Svix mit Shopify Flow

Svix ist die Infrastruktur für Webhooks, auf der Clerk, Resend, Superwall und viele andere Produkte basieren. Wenn Ihr Absender über Svix versendet, überprüft diese Voreinstellung dies. „Workflow Webhooks“ wandelt diesen Aufruf in einen „Shopify Flow“-Trigger um, sodass Ihr Shop darauf reagieren kann: einen Kunden kennzeichnen, eine Bestellnotiz hinzufügen, eine interne E-Mail versenden, ein Metafeld aktualisieren - alles, was Shopify Flow leisten kann.

Dieser Leitfaden legt den gesamten Ablauf fest - Svix sendet, Workflow Webhooks empfängt und überprüft, Shopify Flow führt die Aktion aus -, wobei die HMAC-Signatur von Svix bei jeder Anfrage überprüft wird, sodass ausschließlich Svix Ihren Workflow starten kann.

Was Sie bauen können

  • Tag einen Shopify-Kunden, sobald Clerk meldet, dass dieser sich in Ihrer App registriert oder seine E-Mail-Adresse bestätigt hat.
  • Reagieren Sie auf ein Ereignis zur erneuten Zustellung oder einen Bounce und kennzeichnen Sie den Kunden, dessen Adresse fehlerhaft ist.
  • Empfangen Sie Daten von jedem Svix-basierten Produkt, ohne eine benutzerdefinierte Signatur konfigurieren zu müssen.

Typische zu sendende Ereignisse: alle Ereignisse, die der sendende Dienst definiert.

Dieselbe Voreinstellung überprüft zudem Webhooks von Clerk, Resend und Superwall.

Bevor Sie beginnen

  • Workflow Webhooks in Ihrem Shopify-Shop installiert.
  • Shopify Flow installiert, die kostenlos im App Store unter Shopify erhältlich ist.
  • Ein Konto bei Svix mit der Berechtigung, Webhooks zu erstellen.

Schritt 1 - Erstellen Sie den Webhook unter Workflow Webhooks

  1. Öffnen Sie „Workflow Webhooks“** -> „Webhooks“ -> „Webhook erstellen“** und geben Sie ihm einen Namen, den Sie in Shopify Flow wiedererkennen, beispielsweise Svix events.
  2. Wählen Sie unter „Authentifizierung“ die Option „HMAC“ aus.
  3. Wählen Sie unter „Signaturanbieter“ die Option „Svix“ aus. Die App füllt die Felder „Header“, „Algorithmus“, „signiertes Payload“ und „Wiederholungsfenster“ automatisch für Sie aus - es sind keine weiteren Einstellungen erforderlich.
  4. Lassen Sie das Feld „Secret“ vorerst leer und klicken Sie auf „Speichern“. Kopieren Sie die auf der Seite angezeigte URL des Webhooks.

Informationen zu den anderen Authentifizierungsmodi finden Sie unter Authentifizierung, und unter Zuordnung der Payload-Daten und Flow-Variablen erfahren Sie, welche Felder an Shopify Flow übermittelt werden.

Schritt 2 - Fügen Sie den Endpunkt in Svix hinzu

Fügen Sie die URL als Endpunkt in die Einstellungen der Webhooks des sendenden Dienstes hinzu und zeigen Sie anschließend dessen Signaturschlüssel an und kopieren Sie ihn (er beginnt mit whsec_).

So finden Sie Ihr Svix-Signaturgeheimnis

Das Endpunkt-Signatur-Geheimnis, das mit „whsec_“ beginnt, aus den Einstellungen der Webhooks des Dienstes.

Die Svix-eigene Dokumentation zu Webhook-Signaturen unter enthält den genauen Wortlaut und Screenshots für Ihr Konto.

Fügen Sie diesen Schlüssel in das Feld „Secret“ des Webhooks unter Workflow Webhooks ein und speichern Sie die Eingabe. Ab diesem Zeitpunkt wird jede Svix-Übermittlung überprüft, bevor sie Shopify Flow erreicht.

Was hier überprüft wird

Was Wert
Signaturzeile svix-signature
Wo sich die Unterschrift befindet Der Wert des Headers nach dem Präfix v1,
Was wurde unterzeichnet? {header:svix-id}.{timestamp}.{body}
Unterschrift HMAC-SHA256, Base64-kodiert
Zeitstempel Der Header svix-timestamp als Unix-Sekunden
Wiedergabeschutz Anfragen, deren signierter Zeitstempel mehr als 5 Minuten vom aktuellen Zeitpunkt entfernt ist, werden abgelehnt
Das Geheimnis Vor der Verwendung wird der Text Base64-dekodiert. Das vorangestellte whsec_ wird vor der Dekodierung entfernt. Fügen Sie den Text genau so ein, wie er vom Absender angezeigt wird.

In der signierten Payload entspricht {body} dem Rohtext des Anfrage-Hauptteils, Byte für Byte, {timestamp} dem oben genannten Zeitstempel und {header:svix-id} dem Anfrage-Header svix-id.

Eine Anfrage, die eine dieser Bedingungen nicht erfüllt, wird mit dem Fehler 401 abgelehnt, unter Hintergrund und Fehlerbehebung protokolliert und löst niemals einen Workflow aus.

Schritt 3 - Erstellen Sie den Workflow Shopify Flow

  1. Erstellen Sie in „Shopify Flow“ einen Workflow und wählen Sie den Trigger „Workflow Webhooks“ aus.
  2. Klicken Sie auf „Ereignisse aufzeichnen“ und senden Sie anschließend ein Testereignis aus Svix (oder verwenden Sie die Option „Test senden“ unter Workflow Webhooks), damit Shopify Flow die Struktur Ihrer Daten erlernt.
  3. Jeder Webhook, den Sie besitzen, löst denselben Shopify Flow-Trigger aus. Fügen Sie daher eine erste Bedingung für die Webhook-ID hinzu, um diesen Workflow ausschließlich auf Svix zu beschränken. Die ID wird auf der Webhook-Seite angezeigt.
  4. Fügen Sie Ihre Aktionen hinzu - markieren Sie einen Kunden, fügen Sie eine Notiz hinzu, versenden Sie eine interne E-Mail, aktualisieren Sie ein Metafeld.
Shopify Flow
Wählen Sie unter Shopify Flow die Option „Select a trigger“ aus, öffnen Sie Workflow Webhooks und wählen Sie „Webhook Trigger“ aus.
Eine Shopify Flow-Bedingung: Die Webhook-ID entspricht der ID eines Webhooks
Der erste Schritt jedes Workflows: eine Bedingung bezüglich der Webhook-ID, sodass der Workflow nur für diesen Webhook ausgeführt wird.
Der fertige Workflow: Webhook-Trigger, eine Bedingung basierend auf der Webhook-ID, anschließend „Interne E-Mail senden“ im „True“-Zweig
Der fertige Workflow: Trigger, Bedingung anhand der Webhook-ID, anschließend Ihre Aktion im „True“-Zweig.

Schritt 4 - Testen Sie das System von Anfang bis Ende

Lösen Sie ein echtes Ereignis in Svix aus. Unter „Workflow Webhooks“ → „History“ sollten Sie den Aufruf mit dem Status „Success“ sehen. Falls die Signatur fehlerhaft war, erhalten Sie stattdessen einen fehlgeschlagenen Eintrag mit der entsprechenden Begründung, und unter Überprüfung signierter Webhooks finden Sie Erläuterungen zum Signatur-Tester, der Ihnen genau anzeigt, welcher Schritt fehlgeschlagen ist.

Ein Aufruf wurde im Protokoll „History“ mit seinen Anforderungsheadern, der Payload, dem Status, der Dauer und den Kennungen aufgezeichnet
Ein in „History“ übermittelter Vorgang: Der Status „Erfolgreich“ bedeutet, dass Shopify Flow diesen akzeptiert hat.
Die Signatur stimmt nicht überein▾

In dieser Bestellung: das Geheimnis (die häufigste Ursache - ein zusätzliches Leerzeichen oder ein Schlüssel aus der falschen Umgebung), ob der Absender das Geheimnis eines anderen Endpunkts verwendet und ob irgendetwas zwischen Svix und der App den Hauptteil umschreibt. Signaturen beziehen sich auf die Rohbytes, sodass ein Proxy, der JSON neu formatiert, diese ungültig macht. Der Signatur-Tester auf der Seite für Webhooks zeigt den genauen Text an, der signiert wurde.

Bei jeder Anfrage erhalte ich den Fehlercode 401▾

Bitte überprüfen Sie, ob die Authentifizierung des Webhooks auf „HMAC“ eingestellt ist und der Anbieter „Svix“ ausgewählt ist, ob das Geheimnis eingegeben wurde und ob Svix die Daten genau an die URL sendet, wie sie in der App angezeigt wird, einschließlich des Codes am Ende.

Im Verlauf wird nichts angezeigt▾

Die Anfrage ist nie angekommen. Überprüfen Sie die URL in Svix erneut und sehen Sie sich das eigene Zustellungsprotokoll von Svix an, um die erhaltene Antwort einzusehen. Ein 404 bedeutet, dass der Webhook falsch ist oder gelöscht wurde; ein 429 bedeutet, dass Sie das Aufruflimit Ihres Tarifs überschritten haben - siehe Pläne und Nutzung.

Der Workflow wird bei den falschen Ereignissen ausgeführt▾

Jeder Webhook in Ihrem Shop löst denselben Shopify Flow-Trigger aus. Fügen Sie als ersten Schritt des Workflows eine Bedingung für die Webhook-ID hinzu oder schränken Sie die Ereignisse ein, die Sie von Svix senden.

Anfragen schlagen mit der Fehlermeldung „Zeitstempel außerhalb der Toleranz“ fehl▾

Svix versieht ein Ereignis mit einem Zeitstempel, und die App lehnt alle Ereignisse ab, die älter als 5 Minuten sind. Dies ist in der Regel auf ein Uhrzeitproblem auf der sendenden Seite zurückzuführen oder darauf, dass Svix die Übermittlung erst viel später mit dem ursprünglichen Zeitstempel erneut versucht hat. Wiederholungsversuche derselben ursprünglichen Anfrage werden nicht akzeptiert; bitten Sie Svix, ein neues Ereignis zu senden.

Verwandte Themen