Sådan tilsluttes Linear til Shopify Flow
Linear sender en Webhook, når der sker ændringer i opgaver, projekter eller kommentarer i dit arbejdsområde. Workflow Webhooks omdanner dette kald til en Shopify Flow-udløser, så din butik kan reagere på det: mærke en kunde, tilføje en ordrekommentar, sende en intern e-mail, opdatere et metafelt - alt, hvad Shopify Flow kan gøre.
Denne vejledning beskriver hele forløbet - Linear sender, Workflow Webhooks modtager og verificerer, Shopify Flow udfører - hvor Linears HMAC-signatur kontrolleres ved hver eneste anmodning, så kun Linear kan igangsætte din arbejdsgang.
Hvad du kan bygge
- Send en e-mail til dit merchandising-team, når en fejl med mærket »
storefront« får status »Færdig«. - Skriv det aktuelle sprint- eller udgivelsesnummer ind i et metafelt i butikken.
- Start en arbejdsgang med en tjekliste for butikken, når et lanceringsproblem er afsluttet.
Typiske begivenheder, der skal sendes: Der oprettes en sag, eller dens status ændres; der tilføjes en kommentar; der offentliggøres en projektopdatering.
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å Linear 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.
Linear events. - Vælg HMAC under »Autentificering«.
- Vælg »Linear« under »Signaturudbyder«. Appen udfylder selv overskriften, algoritmen, den signerede Payload og replay-vinduet for dig - der er ikke andet, du skal konfigurere.
- Lad feltet »Secret« være 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 Linear
I Linear skal du åbne Indstillinger -> API -> Webhooks, oprette en webhook med den URL, du har kopieret, og kopiere den signeringsnøgle, der vises der.
Sådan finder du din Linear-signaturnøgle
Den signeringsnøgle, der vises i webhooken i Linear (Indstillinger -> API -> Webhooks).
Linears 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 Linear-levering verificeret, inden den når frem til Shopify Flow.
Hvad dette kontrollerer
| Hvad | Værdi |
|---|---|
| Signaturhoved | Linear-Signature |
| Hvor underskriften er placeret | Hele værdien i overskriften |
| Hvad der er underskrevet | {body} |
| Underskrift | HMAC-SHA256, hex-kodet |
| Tidspunkt | Bruges ikke af denne afsender |
| Beskyttelse mod gentagelse | Ingen - denne afsender underskriver ikke et tidsstempel, så alle gyldige underskrifter forbliver gyldige |
| Hemmeligheden | Bruges som almindelig tekst. Indsæt den nøjagtigt, som afsenderen har angivet den |
I den signerede payload er {body} den ubehandlede anmodningstekst, byte for byte.
En anmodning, der ikke opfylder et af disse krav, afvises med fejlkoden »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 Linear (eller brug funktionen »Send test« i Workflow Webhooks), så Shopify Flow kan lære datastrukturen 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 forbliver lineær. 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 begivenhed i Linear. 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 på 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 Linear 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 anmodning▾
Kontroller, at webhookens godkendelse er indstillet til HMAC med udbyderen Linear valgt, at den hemmelige nøgle er udfyldt, og at Linear sender data til URL’en nøjagtigt som angivet i appen, inklusive koden i slutningen.
Der vises intet under »Historik«▾
Anmodningen blev aldrig modtaget. Kontroller URL’en igen i Linear, og se i Linears egen leveringslog, hvilket svar systemet har modtaget. En 404 betyder, at webhooken er forkert eller slettet, mens en 429 betyder, at du har overskredet dit abonnementets grænse for antallet af opkald - se Planer og anvendelse.
Arbejdsgangen kører for de forkerte hændelser▾
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 begræns de begivenheder, du sender fra Linear.
Relateret
- Bekræftelse af signerede webhooks - alle udbydere, vi verificerer, og hvordan man beskriver en, 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 Linear forsøger at levere igen.
- Historik og fejlfinding - loggen over alle anmodninger, med mulighed for at afspille dem igen.