Opret din første webhook

Her får du en vejledning fra en tom app til en »Shopify Flow«-arbejdsgang, der kører, når dit eget system giver besked om det. Det tager cirka ti minutter.

1. Opret en webhook

Webhooks -> Opret webhook. Siden spørger først, hvad der skal udløse denne webhook, og konfigurerer den derefter i overensstemmelse hermed:

Dit svar Hvad du får
Et automatiseringsværktøj (n8n, Make, Zapier, din egen kode) Et genereret token, der er klar til at blive indsat i værktøjet
En tjeneste, der signerer sine webhooks (Stripe, GitHub, ...) Underskriftsverifikation for den tjeneste, du vælger - se Bekræftelse af signerede webhooks
Et browser- eller webshop-script CORS er aktiveret - se CORS, appens proxy-URL og browseranmodninger
Intet - kør det efter en tidsplan In a webhook, it fetches a URL with specified intervals; the Schedule tab opens next - see Planlagt URL-afstemning
Noget andet, eller beslutter mig senere Du vælger selv, hvordan du vil logge ind

Giv den et navn, du kan genkende senere („Påmindelse om kort til tegnebogen“, „Kontaktformular“), og gem. Alle indstillinger kan ændres senere.

Du har nu en webhook-URL, der slutter med en kort kode, for eksempel https://.../webhook/ab12cd34. Den URL er det endpoint, som dit system sender POST-anmodninger til.

Siden »Opret webhook«, hvor der spørges: »Hvad skal udløse denne webhook?«, med valget »Intet - kør den efter en tidsplan« valgt og en bemærkning om, at fanen »Tidsplan« åbnes herefter
Oprettelsen af en webhook starter med, hvad der skal udløse den. Svaret konfigurerer den tilhørende autentificering; »Intet - kør den efter en tidsplan« åbner derefter fanen »Tidsplan«.
Webhook-editoren: navn og godkendelse til venstre, Endpoint-kortet med status, webhook-URL og webhook-ID til højre, over »Live Preview«, »Test« og »Usage«
Webhook-editoren. Indstillingerne findes til venstre; kortet »Endpoint« til højre indeholder den webhook-URL, du skal give til afsenderen, samt det webhook-ID, du bruger på Shopify Flow.

2. Vælg, hvordan opkaldere skal bevise deres identitet

Åbn webhooken, og vælg en godkendelsesmetode. Se Godkendelse for en fuldstændig sammenligning - her er en kort oversigt:

  • Statisk token - passer til næsten alle. Tryk på knappen »Generer«, kopier tokenet, Send den i overskriften »X-Api-Key«.
  • HMAC SHA-256 - til afsendere, der underskriver deres anmodninger (Stripe, GitHub og lignende).
  • Ingen - kun til testformål. Enhver, der har URL’en, kan starte din arbejdsgang.

3. Fortæl os, hvilke felter der er vigtige for dig

Under »Avancerede indstillinger« kan du tilknytte op til fire felter fra din JSON-payload. Hvis dit system sender:

Fanen »Avancerede indstillinger«, hvor felt 1 til felt 4 er knyttet til henholdsvis orderId, status, total og note
Avancerede indstillinger: Tilknyt op til fire værdier fra anmodningens brødtekst. De modtages i `Shopify Flow` som `fieldOne` til `fieldFour`.
json
{ "customer": { "email": "someone@example.com" }, "orderId": "1001" }

Omdiriger fieldOne til orderId og fieldTwo til customer.email - i indlejrede stier skal der bruges prikker. Se alle detaljer på Kortlægning af payload og strømningsvariabler.

4. Send en testanmodning

En anmodning, der blev åbnet i History med dens anmodningsheadere, Payload, status, varighed og identifikatorer
Efter en testanmodning vises kaldet i »Historik« sammen med Payloaden, der er modtaget.
bash
curl -X POST https://your-app-url/webhook/ab12cd34 \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-token" \
  -d '{"orderId":"1001","customer":{"email":"someone@example.com"}}'

Åbn »History«. Her bør du kunne se opkaldet med dets status, overskrifter og Payload. Hvis det ikke er der, kan du finde en liste over alle afvisningsårsager på Historik og fejlfinding.

5. Opret en Shopify Flow-arbejdsgang

I »Shopify Flow« skal du oprette en arbejdsgang, der starter med udløseren »Webhook Trigger«.

  1. Tilføj udløseren, og klik på »Optag begivenheder«.
  2. Kom tilbage hertil, åbn opkaldet i »Historik«, og tryk på »Afspil igen«. Shopify Flow har nu en et konkret eksempel på en payload, man kan arbejde med - det er meget nemmere end at gætte på feltnavne.
  3. Tilføj en betingelse: Webhook ID skal svare til dit webhook-id (som vises på webhook-siden). Hvert »Webhook Trigger«-arbejdsgang modtager begivenheder fra alle dine webhooks, så dette Det er denne betingelse, der får arbejdsgangen til kun at reagere på netop denne.
  4. Tilføj dine handlinger ved at sende en e-mail til {{fieldFour}} med emnet »{{fieldOne}}«.
  5. Aktivér arbejdsgangen.
Shopify Flow
I »Shopify Flow« skal du vælge »Select a trigger«, åbne »Workflow Webhooks« og vælge »Webhook Trigger«.
Plus-tegnet under trinnet »Webhook-udløser« åbnede sig og viste valgmulighederne »Handling« og »Betingelse«
P-tegnet under et trin indeholder de to elementer, som en arbejdsgang består af: en betingelse og en handling.
I Shopify Flow: Webhook-id’et er det samme som ID’et for en bestemt webhook
Det første trin i enhver arbejdsgang: en betingelse baseret på webhook-ID’et, så arbejdsgangen kun udføres for netop denne webhook.
Shopify Flow-panel »Tilføj en variabel« til Webhook-udløseren, hvor webhookId og fieldOne til fieldFour vises med eksempelværdier fra en nylig anmodning
Hvad udløseren leverer til din arbejdsgang: webhook-ID’et og dine fire tilknyttede felter, vist med værdierne fra en nylig anmodning.
Shopify Flow-handlingen »Send intern e-mail« med fieldOne og fieldTwo i emnefeltet og fieldThree og fieldFour i meddelelsesteksten
Brug de tilknyttede felter overalt, hvor en Shopify Flow-handling tager en variabel - her i emnefeltet og meddelelsesteksten i en intern e-mail.
Den færdige arbejdsgang: Webhook-udløser, en betingelse baseret på webhook-id’et, og derefter »Send intern e-mail« på »True«-grenen
Den færdige arbejdsgang: udløser, betingelse baseret på webhook-ID’et, og derefter din handling på »True«-grenen.

6. Gå live

Indstil dit egentlige system til webhook-URL’en. Hold øje med de første par opkald i historikken for at sikre, at de kommer frem og gennemføres korrekt.

Hvis din afsender forsøger igen, når der er sket en timeout, skal du aktivere »Beskyttelse mod dobbeltlevering«, så et nyt forsøg ikke kan udføre din arbejdsgang to gange.

Siden »Webhooks« viser en liste over seks webhooks, hver med antallet af aktiveringer, godkendelsesoplysninger og en markering for »Aktiveret« eller »Deaktiveret«
Siden »Webhooks«. Hver række viser, hvor ofte webhooken er blevet kaldt, hvordan de, der kalder den, autentificerer sig, og om den er aktiveret; via menuen til højre kan man aktivere, deaktivere eller slette den.