Hoe koppelt u Sanity aan Shopify Flow?

Q: De handtekening komt niet overeen

In deze bestelling: het geheim (de meest voorkomende oorzaak - een extra spatie of een sleutel uit de verkeerde omgeving), of de afzender het geheim van een ander eindpunt gebruikt, en of er iets tussen Sanity en de app staat dat de body herschrijft . Handtekeningen hebben betrekking op de ruwe bytes, dus een proxy die JSON opnieuw opmaakt, maakt ze ongeldig. De handtekeningcontrole op de webhook-pagina toont de exacte tekst die is ondertekend.

Sanity verstuurt een door GROQ aangestuurde Webhook telkens wanneer er inhoud wordt aangemaakt, bijgewerkt of verwijderd die overeenkomt met uw zoekopdracht. Workflow Webhooks zet die oproep om in een trigger voor „Shopify Flow”, zodat uw winkel hierop kan reageren: een klant taggen, een opmerking bij een bestelling toevoegen, een interne e-mail versturen, een metaveld bijwerken - alles Shopify Flow kan doen.

Deze handleiding beschrijft het volledige proces - Sanity verzendt, Workflow Webhooks ontvangt en controleert, Shopify Flow voert de actie uit - waarbij bij elk verzoek de HMAC-handtekening van Sanity wordt gecontroleerd, zodat uitsluitend Sanity uw workflow kan starten.

Wat u kunt bouwen

Werk het metaveld Shopify bij wanneer het bijbehorende CMS-item wordt gewijzigd, zodat de webshop synchroon blijft lopen.
Stuur een e-mail naar uw merchandisingteam zodra een landingspagina is gepubliceerd.
Start na een inhoudsrelease een workflow voor het opwarmen van de cache.

Typische gebeurtenissen die moeten worden doorgegeven: een document wordt gepubliceerd, een document wordt bijgewerkt, een document wordt verwijderd.

Voordat u begint

Workflow Webhooks geïnstalleerd in uw Shopify-winkel.
Shopify Flow geïnstalleerd, dat gratis te downloaden is via de App Store op Shopify.
Een account bij Sanity met toestemming om webhooks aan te maken.

Stap 1 - Maak de webhook aan op Workflow Webhooks

Ga naar Workflow Webhooks -> Webhooks -> Maak een webhook aan en geef deze een naam die u in Shopify Flow zult herkennen, bijvoorbeeld Sanity events.
Kies onder ‘Authenticatie’ de optie ‘HMAC’.
Kies bij „Signature provider“ de optie „Sanity“. De app vult de header, het algoritme, de ondertekende payload en het replay-venster automatisch voor u in - u hoeft verder niets meer in te stellen.
Laat het veld ‘geheim’ voorlopig leeg en klik op ‘Opslaan’. Kopieer de webhook-URL die op de pagina wordt weergegeven.

Zie Authenticatie voor de overige authenticatiemodi en Toewijzing van payloads en Flow-variabelen voor informatie over welke velden naar Shopify Flow worden verzonden.

Stap 2 - Voeg het eindpunt toe in Sanity

Ga in Sanity naar API -> Webhooks, maak een door GROQ aangestuurde webhook aan met de URL die u hebt gekopieerd en stel de geheimcode in.

Hoe u uw Sanity-ondertekeningsgeheim kunt vinden

De instelling „Secret“ voor de door GROQ aangestuurde webhook.

In de documentatie van Sanity zelf over webhook-handtekeningen vindt u de exacte bewoordingen en schermafbeeldingen voor uw account.

Plak dat geheim in het veld ‘Secret’ van de webhook op Workflow Webhooks en sla het op. Vanaf dat moment wordt elke Sanity-levering geverifieerd voordat deze Shopify Flow bereikt.

Wat hiermee wordt gecontroleerd

Wat	Waarde
Handtekeningkoptekst	`sanity-webhook-signature`
Waar de handtekening staat	In de waarde `v1` van die header, die `key=value`-paren bevat, gescheiden door komma’s
Wat is ondertekend?	`{timestamp}.{body}`
Handtekening	HMAC-SHA256, gecodeerd met base64url
Tijdstempel	De waarde van de parameter `t` in de handtekeningheader, uitgedrukt in Unix-milliseconden
Bescherming tegen herhaling	Geen - deze afzender ondertekent geen tijdstempel, zodat elke geldige handtekening geldig blijft
Het geheim	Wordt als platte tekst gebruikt. Plak de tekst precies zoals de afzender deze weergeeft

In de ondertekende payload is {body} de onbewerkte inhoud van het verzoek, byte voor byte, en {timestamp} is de hierboven vermelde tijdstempel.

Een verzoek dat aan een van deze voorwaarden niet voldoet, wordt afgewezen met de foutmelding 401, wordt geregistreerd in Geschiedenis en probleemoplossing en leidt nooit tot het starten van een workflow.

Stap 3 - Stel de workflow Shopify Flow samen

Maak in ‘Shopify Flow’ een workflow aan en kies de trigger ‘Workflow Webhooks’.
Klik op ‘Gebeurtenissen vastleggen’ en verstuur vervolgens een testgebeurtenis vanuit Sanity (of gebruik de optie ‘Test verzenden’ in Workflow Webhooks), zodat Shopify Flow de structuur van uw gegevens leert kennen.
Elke webhook die u bezit, activeert dezelfde Shopify Flow-trigger; voeg daarom een eerste voorwaarde toe op basis van de webhook-ID om deze workflow uitsluitend voor Sanity te reserveren. De ID wordt weergegeven op de webhook-pagina.
Voeg uw acties toe - tag een klant, voeg een notitie toe, verstuur een interne e-mail, werk een metaveld bij.

Een Shopify Flow-voorwaarde: de webhook-ID is gelijk aan de ID van één webhook — De eerste stap van elke workflow: een voorwaarde op basis van de webhook-ID, zodat de workflow uitsluitend voor deze webhook wordt uitgevoerd.

De voltooide workflow: Webhook-trigger, een voorwaarde op basis van de webhook-ID, gevolgd door het verzenden van een interne e-mail in de „True“-tak — De voltooide workflow: trigger, voorwaarde op basis van de webhook-ID, gevolgd door uw actie in de „True“-tak.

Stap 4 - Test het van begin tot eind

Activeer een echte gebeurtenis in Sanity. Onder ‘Workflow Webhooks’ -> ‘History’ zou u de aanroep moeten zien met de status ‘Success’. Indien de handtekening onjuist was, krijgt u in plaats daarvan een mislukte vermelding met de reden, en op Gecertificeerde webhooks verifiëren vindt u uitleg over de handtekeningtester die u precies laat zien welke stap is mislukt.

Eén aanroep werd in History geopend, met de verzoekheaders, de payload, de status, de duur en de identificatiegegevens — Een voltooide gebeurtenis in History: de status ‘Succes’ betekent dat Shopify Flow deze heeft geaccepteerd.

De handtekening komt niet overeen▾

In deze bestelling: het geheim (de meest voorkomende oorzaak - een extra spatie of een sleutel uit de verkeerde omgeving), of de afzender het geheim van een ander eindpunt gebruikt, en of er iets tussen Sanity en de app staat dat de body herschrijft. Handtekeningen hebben betrekking op de ruwe bytes, dus een proxy die JSON opnieuw opmaakt, maakt ze ongeldig. De handtekeningcontrole op de webhook-pagina toont de exacte tekst die is ondertekend.

Bij elk verzoek krijg ik een 401-foutmelding▾

Controleer of de authenticatie van de webhook is ingesteld op HMAC met de provider Sanity geselecteerd, of het geheim is ingevuld en of Sanity de gegevens naar de URL verstuurt precies zoals deze in de app wordt weergegeven, inclusief de code aan het einde.

Er wordt niets weergegeven in de geschiedenis▾

Het verzoek is nooit aangekomen. Controleer de URL nogmaals in Sanity en bekijk het eigen afleveringslogboek van Sanity om te zien welk antwoord het heeft ontvangen. Een 404 duidt op een onjuiste of verwijderde webhook, een 429 betekent dat u de limiet voor het aantal aanroepen van uw abonnement hebt overschreden - zie Abonnementen en gebruik.

De workflow wordt voor de verkeerde gebeurtenissen uitgevoerd▾

Elke webhook in uw winkel activeert dezelfde Shopify Flow-trigger. Voeg als eerste stap van de workflow een voorwaarde toe op basis van de webhook-ID, of beperk de gebeurtenissen die u vanuit Sanity verstuurt.

Gerelateerd

Gecertificeerde webhooks verifiëren - elke aanbieder die wij controleren, en hoe wij een aanbieder beschrijven die wij niet controleren.
Toewijzing van payloads en Flow-variabelen - de juiste velden uit de payload halen en in Shopify Flow invoeren.
Bescherming tegen dubbele leveringen - wat er gebeurt wanneer Sanity een bezorgpoging herhaalt.
Geschiedenis en probleemoplossing - het logboek van elk verzoek, inclusief de mogelijkheid tot herhaling.