Sådan tilsluttes Svix til Shopify Flow
Svix er den infrastruktur, der ligger bag Clerk, Resend, Superwall og mange andre produkter. Hvis din afsender leverer via Svix, bekræfter denne forudindstilling dette. Workflow Webhooks omdanner dette opkald til en Shopify Flow-udløser, så din butik kan reagere på det: mærk en kunde, tilføj en ordrebemærkning, send en intern e-mail, opdater et metafelt - alt, hvad Shopify Flow kan gøre.
Denne vejledning beskriver hele forløbet - Svix sender, Workflow Webhooks modtager og verificerer, Shopify Flow udfører - hvor Svix’ HMAC-signatur kontrolleres ved hver eneste anmodning, så kun Svix kan starte din arbejdsgang.
Hvad du kan bygge
- Tag en »Shopify«-kunde, når Clerk melder, at vedkommende har tilmeldt sig eller bekræftet sin e-mail-adresse i jeres app.
- Reager på en begivenhed vedrørende genudsendelse eller returnering, og markér den kunde, hvis adresse giver fejl.
- Modtag data fra ethvert Svix-baseret produkt uden at skulle konfigurere en brugerdefineret signatur.
Typiske hændelser, der skal sendes: enhver hændelse, som den afsendende tjeneste definerer.
Den samme forudindstilling verificerer også webhooks fra Clerk, Resend og Superwall.
Før du går i gang
- Workflow Webhooks installeret på din Shopify-butik.
- Shopify Flow installeret, som kan hentes gratis fra App Store på Shopify.
- En konto på Svix med tilladelse til at oprette webhooks.
Trin 1 - Opret webhook på Workflow Webhooks
- Åbn Workflow Webhooks -> Webhooks -> Opret webhook, og giv den et navn, du kan genkende i Shopify Flow, f.eks.
Svix events. - Vælg HMAC under »Autentificering«.
- Vælg »Svix« under »Signaturudbyder«. Appen udfylder overskriften, algoritmen, den signerede payload og replay-vinduet for dig - der er ikke andet, du skal konfigurere.
- Lad feltet »Secret« stå tomt foreløbig, og klik på »Gem«. Kopier den webhook-URL, der vises på siden.
Se Godkendelse for de øvrige godkendelsesmetoder og Kortlægning af payload og strømningsvariabler for at vælge, hvilke felter der skal sendes til Shopify Flow.
Trin 2 - Tilføj endepunktet i Svix
Indtast URL’en som slutpunkt i den afsendende tjenestes webhook-indstillinger, og vis og kopier derefter dens signeringsnøgle (den starter med whsec_).
Sådan finder du din Svix-signeringsnøgle
Den hemmelige nøgle til signering af endepunktet, der begynder med »whsec_«, fra tjenestens webhook-indstillinger.
Svix’ egen dokumentation om webhook-signaturer indeholder den nøjagtige ordlyd og skærmbilleder til netop din konto.
Indsæt den hemmelige nøgle i feltet »Secret« for webhooken på Workflow Webhooks og gem. Fra det øjeblik bliver hver eneste Svix-levering verificeret, inden den når frem til Shopify Flow.
Hvad dette kontrollerer
| Hvad | Værdi |
|---|---|
| Signaturhoved | svix-signature |
| Hvor underskriften er placeret | Værdien i overskriften, efter præfikset v1, |
| Hvad der er underskrevet | {header:svix-id}.{timestamp}.{body} |
| Underskrift | HMAC-SHA256, base64-kodet |
| Tidspunkt | svix-timestamp-overskriften, udtrykt i Unix-sekunder |
| Beskyttelse mod gentagelse | Anmodninger, hvis signerede tidsstempel ligger mere end 5 minutter fra nu, afvises |
| Hemmeligheden | Afkodes til Base64 før brug. Den indledende whsec_ fjernes før afkodningen. Indsæt den nøjagtigt, som afsenderen viser den |
I den signerede payload er {body} den ubehandlede anmodningstekst, byte for byte, mens {timestamp} er ovenstående tidsstempel, og {header:svix-id} er anmodningsheaderen »svix-id«.
En anmodning, der ikke opfylder et af disse kriterier, afvises med fejlmeddelelsen »401«, registreres i »Historik og fejlfinding« og udløser aldrig en arbejdsgang.
Trin 3 - Opret arbejdsgangen »Shopify Flow«
- I »Shopify Flow« skal du oprette en arbejdsgang og vælge udløseren »Workflow Webhooks«.
- Tryk på »Optag begivenheder«, og send derefter en testbegivenhed fra Svix (eller brug »Send test« i Workflow Webhooks), så Shopify Flow kan lære dataenes struktur at kende.
- Hver eneste webhook, du ejer, udløser den samme Shopify Flow-trigger, så tilføj en første betingelse baseret på webhook-id’et for at sikre, at denne arbejdsgang kun kører i Svix. Id’et vises på webhook-siden.
- Tilføj dine handlinger - tag en kunde, tilføj en note, send en intern e-mail, opdater et metafelt.
Trin 4 - Test det fra start til slut
Udløs en reel hændelse i Svix. Under »Workflow Webhooks« → »History« bør du kunne se opkaldet med status »Success«. Hvis signaturen var forkert, får du i stedet en fejlmeddelelse med årsagen, og på Bekræftelse af signerede webhooks finder du en forklaring til signaturtesteren, der viser dig præcis, hvilket trin der mislykkedes.
Underskriften stemmer ikke overens▾
I denne ordre: hemmeligheden (den mest almindelige årsag - et ekstra mellemrum eller en nøgle fra det forkerte miljø), om afsenderen bruger en anden endpunkts hemmelighed, og om noget mellem Svix og appen omskriver brødteksten. Signaturerne dækker de rå bytes, så en proxy, der omformaterer JSON, ødelægger dem. Signaturtesteren på webhook-siden viser den nøjagtige tekst, der blev signeret.
Jeg får en 401-fejl ved hver eneste forespørgsel▾
Kontroller, at webhookens autentificering er indstillet til HMAC med Svix valgt som udbyder, at den hemmelige nøgle er udfyldt, og at Svix sender data til URL’en nøjagtigt som angivet i appen, inklusive koden i slutningen.
Der vises intet under »Historik«▾
Anmodningen blev aldrig modtaget. Tjek URL’en igen i Svix, og se i Svix’ egen leveringslog, hvilket svar systemet modtog. En 404 betyder, at webhooken er forkert eller slettet, mens en 429 betyder, at du har overskredet dit abonnements grænse for antal opkald - se Planer og anvendelse.
Arbejdsgangen kører for de forkerte begivenheder▾
Hver eneste webhook i din butik udløser den samme Shopify Flow-trigger. Tilføj en betingelse baseret på webhook-id’et som det første trin i arbejdsgangen, eller indsnæv de begivenheder, du sender fra Svix.
Anmodningerne mislykkes med fejlmeddelelsen »tidsstempel uden for tolerancen«▾
Svix underskriver en tidsstempel, og appen afviser alt, der er mere end 5 minutter gammelt. Dette skyldes normalt et urproblem hos afsenderen eller en levering, som Svix har forsøgt at sende igen meget senere med den oprindelige tidsstempel. Gentagne forsøg fra den samme oprindelige anmodning kan ikke godkendes; bed Svix om at sende en ny begivenhed.
Relateret
- Bekræftelse af signerede webhooks - alle udbydere, vi verificerer, og hvordan man beskriver en udbyder, som vi ikke verificerer.
- Kortlægning af payload og strømningsvariabler - at udtrække de rigtige felter fra payloadet og overføre dem til Shopify Flow.
- Beskyttelse mod dobbeltlevering - hvad der sker, når Svix forsøger at levere igen.
- Historik og fejlfinding - loggen over alle anmodninger, med mulighed for afspilning.