So verbinden Sie Sanity mit Shopify Flow

Q: Die Signatur stimmt nicht überein

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

Sanity sendet einen von GROQ gestützten Webhook, sobald Inhalte erstellt, aktualisiert oder gelöscht werden, die Ihrer Suchanfrage entsprechen. „Workflow Webhooks“ wandelt diesen Aufruf in einen „Shopify Flow“-Trigger um, sodass Ihr Shop darauf reagieren kann: einen Kunden taggen, eine Bestellnotiz hinzufügen, eine interne E-Mail versenden, ein Metafeld aktualisieren - alles, was Shopify Flow leisten kann.

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

Was Sie bauen können

Aktualisieren Sie das Metafeld Shopify, sobald sich der entsprechende CMS-Eintrag ändert, damit die Storefront stets auf dem neuesten Stand bleibt.
Bitte senden Sie Ihrem Merchandising-Team eine E-Mail, sobald eine Landingpage veröffentlicht wurde.
Starten Sie nach einer Inhaltsveröffentlichung einen Cache-Warming-Workflow.

Typische Ereignisse, die gesendet werden: Ein Dokument wird veröffentlicht, ein Dokument wird aktualisiert, ein Dokument wird gelöscht.

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 Sanity mit der Berechtigung, Webhooks zu erstellen.

Schritt 1 - Erstellen Sie den Webhook unter Workflow Webhooks

Öffnen Sie Workflow Webhooks -> Webhooks -> „Webhook erstellen“ und geben Sie ihm einen Namen, den Sie in Shopify Flow wiedererkennen, beispielsweise Sanity events.
Wählen Sie unter „Authentifizierung“ die Option „HMAC“ aus.
Wählen Sie unter „Signaturanbieter“ die Option „Sanity“ aus. Die App füllt die Felder „Header“, „Algorithmus“, „signierte Payload“ und „Wiederholungsfenster“ automatisch für Sie aus - es sind keine weiteren Einstellungen erforderlich.
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 Sanity hinzu

Öffnen Sie in Sanity „API“ → „Webhooks“, erstellen Sie einen GROQ-basierten Webhook mit der von Ihnen kopierten URL und legen Sie den geheimen Schlüssel fest.

So finden Sie Ihr Sanity-Signaturgeheimnis

Die Einstellung „Secret“ für den von GROQ bereitgestellten Webhook.

In der offiziellen Dokumentation von Sanity zu Webhook-Signaturen unter finden Sie den genauen Wortlaut sowie 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 Sanity-Übermittlung überprüft, bevor sie Shopify Flow erreicht.

Was damit überprüft wird

Was	Wert
Signaturzeile	`sanity-webhook-signature`
Wo sich die Unterschrift befindet	Im Wert `v1` dieses Headers, der durch Kommas getrennte `key=value`-Paare enthält
Was wurde unterzeichnet?	`{timestamp}.{body}`
Unterschrift	HMAC-SHA256, Base64URL-kodiert
Zeitstempel	Der Wert `t` des Signatur-Headers, angegeben in Unix-Millisekunden
Wiedergabeschutz	Keine - dieser Absender signiert keinen Zeitstempel, daher bleibt jede gültige Signatur gültig
Das Geheimnis	Wird als Klartext verwendet. Fügen Sie den Text genau so ein, wie er vom Absender angegeben wird.

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

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

Schritt 3 - Erstellen Sie den Workflow Shopify Flow

Erstellen Sie in „Shopify Flow“ einen Workflow und wählen Sie den Trigger „Workflow Webhooks“ aus.
Klicken Sie auf „Ereignisse aufzeichnen“ und senden Sie anschließend ein Testereignis aus Sanity (oder verwenden Sie die Option „Test senden“ unter Workflow Webhooks), damit Shopify Flow die Struktur Ihrer Daten erkennt.
Jeder Webhook, den Sie besitzen, löst denselben Shopify Flow-Trigger aus. Fügen Sie daher eine erste Bedingung anhand der Webhook-ID hinzu, um diesen Workflow ausschließlich auf Sanity zu beschränken. Die ID wird auf der Webhook-Seite angezeigt.
Fügen Sie Ihre Aktionen hinzu - kennzeichnen Sie einen Kunden, fügen Sie eine Notiz hinzu, versenden Sie eine interne E-Mail, aktualisieren Sie ein Metafeld.

Eine Shopify Flow-Bedingung: Die Webhook-ID entspricht der ID eines Webhooks — Der erste Schritt jedes Workflows: eine Bedingung bezüglich der Webhook-ID, damit der Workflow nur für diesen Webhook ausgeführt wird.

Der fertige Workflow: Webhook-Trigger, eine Bedingung anhand 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 Sanity 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 „Erfolg“ bedeutet, dass Shopify Flow diesen akzeptiert hat.

Die Signatur stimmt nicht überein▾

In dieser Reihenfolge: das Geheimnis (die häufigste Ursache - ein überflüssiges Leerzeichen oder ein Schlüssel aus der falschen Umgebung), ob der Absender das Geheimnis eines anderen Endpunkts verwendet und ob irgendetwas zwischen Sanity und der App den Hauptteil umschreibt. Signaturen beziehen sich auf die Rohdaten, sodass ein Proxy, der JSON neu formatiert, diese ungültig macht. Der Signatur-Tester auf der Webhook-Seite 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 „Sanity“ ausgewählt wurde, ob das Geheimnis eingegeben wurde und ob Sanity 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 erneut in Sanity und sehen Sie sich das eigene Zustellungsprotokoll von Sanity 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 Plans ü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 Sanity senden.