So verbinden Sie Vercel mit Shopify Flow

Q: Die Signatur stimmt nicht überein

In dieser Reihenfolge: 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 Vercel 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 Webhook-Seite zeigt den genauen Text an, der signiert wurde.

Vercel sendet einen Webhook, wenn ein Deployment erstellt wird, erfolgreich verläuft, fehlschlägt oder wenn sich ein Projekt oder eine Domain ändert. Workflow Webhooks wandelt diesen Aufruf in einen „Shopify Flow“-Trigger um, sodass Ihr Shop darauf reagieren kann: einen Kunden mit einem Tag versehen, eine Bestellnotiz hinzufügen, eine interne E-Mail versenden, ein Metafeld aktualisieren - alles, was Shopify Flow leisten kann.

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

Was Sie bauen können

Senden Sie Ihrem Team eine E-Mail, wenn die Bereitstellung eines Headless-Storefronts fehlschlägt.
Tragen Sie nach jeder erfolgreichen Bereitstellung die Live-Bereitstellungs-ID in ein Shop-Metafeld ein.
Starten Sie einen Workflow zum Aufwärmen des Caches oder zur Neuindizierung, sobald eine Bereitstellung bereit ist.

Typische Ereignisse, die gesendet werden sollten: deployment.succeeded, deployment.error, project.created.

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 Vercel 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 Vercel events.
Wählen Sie unter „Authentifizierung“ die Option „HMAC“ aus.
Wählen Sie unter „Signaturanbieter“ die Option „Vercel“ aus. Die App füllt die Felder „Header“, „Algorithmus“, „signierte Payload“ und „Wiederholungsfenster“ automatisch für Sie aus - es sind keine weiteren Konfigurationen 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 Informationen zur Auswahl der Felder, die an Shopify Flow übermittelt werden, finden Sie unter Zuordnung der Payload-Daten und Flow-Variablen.

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

Öffnen Sie in Vercel „Einstellungen“ -> „Webhooks“ für das Team oder Projekt, erstellen Sie einen Webhook mit der von Ihnen kopierten URL und kopieren Sie den dort angezeigten geheimen Schlüssel.

So finden Sie Ihr Vercel-Signaturgeheimnis

Das Webhook-Geheimnis, das bei der Erstellung des Webhooks angezeigt wurde (bzw. das Client-Geheimnis der Integration).

In der Vercel-eigenen Dokumentation 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 Vercel-Bereitstellung überprüft, bevor sie Shopify Flow erreicht.

Was hier überprüft wird

Was	Wert
Signaturzeile	`x-vercel-signature`
Wo sich die Unterschrift befindet	Der gesamte Wert des Headers
Was wurde unterzeichnet?	`{body}`
Unterschrift	HMAC-SHA1, hexadezimal kodiert
Zeitstempel	Wird von diesem Absender nicht verwendet
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.

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

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 von Vercel (oder verwenden Sie die Option „Test senden“ unter Workflow Webhooks), damit Shopify Flow die Struktur Ihrer Daten erfasst.
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 Vercel zu beschränken. Die ID wird auf der Webhook-Seite angezeigt.
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.

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 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 durchgängig

Triggeren Sie ein echtes Ereignis in Vercel. Unter „Workflow Webhooks“ → „History“ sollten Sie den Aufruf mit dem Status „Success“ sehen. Sollte die Signatur falsch gewesen sein, erhalten Sie stattdessen einen fehlgeschlagenen Eintrag mit der entsprechenden Begründung; 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 Identifikatoren aufgezeichnet — Ein in „History“ übermittelter Vorgang: Der Status „Erfolgreich“ bedeutet, dass Shopify Flow diesen akzeptiert hat.

Die Signatur stimmt nicht überein▾

In dieser Reihenfolge: 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 Vercel 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 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 „Vercel“ ausgewählt ist, ob das Geheimnis eingegeben wurde und ob Vercel die Anfrage 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 eingegangen. Überprüfen Sie die URL in Vercel noch einmal und sehen Sie sich das von Vercel selbst geführte Protokoll an, um festzustellen, welche Antwort eingegangen ist. 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 Vercel senden.