Maak uw eerste webhook aan

Hierin wordt u begeleid van een lege app naar een Shopify Flow-workflow die wordt uitgevoerd wanneer uw eigen systeem daartoe opdracht geeft. Dit duurt ongeveer tien minuten.

1. Maak een webhook aan

Webhooks -> Webhook aanmaken. Op de pagina wordt eerst gevraagd wat deze webhook zal activeren, waarna de instellingen hierop worden afgestemd:

Uw antwoord Wat u krijgt
Een automatiseringstool (n8n, Make, Zapier, uw eigen code) Een gegenereerd token, klaar om in de tool te plakken
Een dienst die zijn webhooks ondertekent (Stripe, GitHub, ...) Handtekeningverificatie voor de door u gekozen dienst - zie Gecertificeerde webhooks verifiëren
Een browser- of webshop-script CORS is ingeschakeld - zie CORS, de URL van de app-proxy en browserverzoeken
Niets - voer het volgens een schema uit Een webhook die op gezette tijden een URL ophaalt; het tabblad ‘Schema’ wordt vervolgens geopend - zie Geplande URL-controle
Iets anders, of later beslissen U kiest zelf de authenticatiemethode

Geef het een naam die u later zult herkennen („Herinnering portemonneekaart”, „Contactformulier”) en sla het op. Elke instelling kan achteraf worden gewijzigd.

U beschikt nu over een webhook-URL die eindigt op een korte code, bijvoorbeeld https://.../webhook/ab12cd34. Die URL is het eindpunt waarnaar uw systeem een POST-verzoek verstuurt.

Op de pagina ‘Webhook aanmaken’ wordt gevraagd: ‘Wat zal deze webhook activeren?’, waarbij de optie ‘Niets - volgens een schema uitvoeren’ is geselecteerd en wordt vermeld dat het tabblad ‘Schema’ vervolgens wordt geopend
Het aanmaken van een webhook begint met de vraag wat de webhook zal activeren. Het antwoord zorgt ervoor dat de bijbehorende authenticatie wordt ingesteld; bij „Niets - volgens een schema uitvoeren“ wordt vervolgens het tabblad „Schema“ geopend.
De webhook-editor: naam en authenticatie aan de linkerkant, de Endpoint-kaart met status, webhook-URL en webhook-ID aan de rechterkant, met daarboven ‘Live Preview’, ‘Test’ en ‘Usage’
De webhook-editor. De instellingen bevinden zich aan de linkerkant; op de kaart ‘Endpoint’ aan de rechterkant vindt u de webhook-URL die u aan de afzender moet verstrekken en de webhook-ID die u gebruikt in Shopify Flow.

2. Bepaal op welke manier bellers hun identiteit moeten aantonen

Open de webhook en kies een authenticatiemethode. Zie Authenticatie voor een volledig overzicht - in het kort:

  • Statisch token - geschikt voor vrijwel iedereen. Klik op de knop ‘Genereren’, kopieer het token, vermeld dit in de koptekst X-Api-Key.
  • HMAC SHA-256 - voor afzenders die hun verzoeken ondertekenen (Stripe, GitHub en dergelijke).
  • Geen - uitsluitend voor testdoeleinden. Iedereen die over de URL beschikt, kan uw workflow starten.

3. Geef aan welke vakgebieden voor u van belang zijn

Onder ‘Geavanceerde instellingen’ kunt u maximaal vier velden uit uw JSON-payload toewijzen. Als uw systeem het volgende verzendt:

Het tabblad ‘Geavanceerde instellingen’, waarbij Veld 1 tot en met Veld 4 zijn gekoppeld aan orderId, status, total en note
Geavanceerde instellingen: koppel maximaal vier waarden uit de verzoektekst. Deze worden in `Shopify Flow` weergegeven als `fieldOne` tot en met `fieldFour`.
json
{ "customer": { "email": "someone@example.com" }, "orderId": "1001" }

Koppel fieldOne naar orderId en fieldTwo naar customer.email - gebruik punten bij geneste paden. Volledige informatie vindt u op Toewijzing van payloads en Flow-variabelen.

4. Een testverzoek verzenden

Eén aanroep werd in History geopend, met de verzoekheaders, de payload, de status, de duur en de identificatiegegevens
Na een testverzoek verschijnt de aanroep in de Geschiedenis, samen met de ontvangen payload.
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"}}'

Open History. U zou de aanroep moeten zien, inclusief de status, de headers en de payload. Mocht deze er niet staan, dan vindt u op Geschiedenis en probleemoplossing een overzicht van alle redenen voor afwijzing.

5. Stel de Shopify Flow-workflow samen

Maak in 'Shopify Flow' een workflow aan die begint met de trigger 'Webhook Trigger'.

  1. Voeg de trigger toe en klik op ‘Gebeurtenissen vastleggen’.
  2. Kom hier terug, open de opdracht in de Geschiedenis en druk op ‘Opnieuw afspelen’. Shopify Flow heeft nu een een echt voorbeeld van een payload om mee te werken - veel eenvoudiger dan het raden van veldnamen.
  3. Voeg een voorwaarde toe: Webhook ID is gelijk aan de ID van uw webhook (weergegeven op de webhook-pagina). Elke Webhook Trigger-workflow ontvangt gebeurtenissen van al uw webhooks, dus dit Deze voorwaarde zorgt ervoor dat de workflow uitsluitend op deze ene reactie reageert.
  4. Voeg uw acties toe via {{fieldOne}} aan {{fieldFour}}.
  5. Schakel de workflow in.
Shopify Flow
Kies in Shopify Flow de optie ‘Select a trigger’, open Workflow Webhooks en selecteer ‘Webhook Trigger’.
Het plusteken onder de stap ‘Webhook-trigger’ werd geopend, waarna de opties ‘Actie’ en ‘Voorwaarde’ werden weergegeven
Het plusteken onder een stap biedt de twee elementen waaruit een workflow bestaat: een voorwaarde en een actie.
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.
Het paneel ‘Variabele toevoegen’ van Shopify Flow voor de Webhook-Trigger, waarin webhookId en fieldOne tot en met fieldFour worden weergegeven met voorbeeldwaarden uit een recent verzoek
Wat de trigger aan uw workflow doorgeeft: de webhook-ID en uw vier toegewezen velden, weergegeven met de waarden van een recent verzoek.
De actie ‘Interne e-mail verzenden’ van Shopify Flow, waarbij fieldOne en fieldTwo in het onderwerp staan en fieldThree en fieldFour in de tekst van het bericht
Gebruik de toegewezen velden overal waar een Shopify Flow-actie een variabele vereist, in dit geval in het onderwerp en de tekst van een interne e-mail.
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.

6. Live gaan

Stel uw daadwerkelijke systeem in op de webhook-URL. Controleer de eerste paar verzoeken in de geschiedenis om te verifiëren of deze aankomen en succesvol zijn.

Indien uw verzender na het verstrijken van de time-out een nieuwe poging onderneemt, schakel dan de optie Bescherming tegen dubbele leveringen in, zodat een herhalingspoging uw workflow niet tweemaal kan uitvoeren.

De pagina ‘Webhooks’ waarop zes webhooks worden weergegeven, elk met het aantal keer dat ze zijn aangeroepen, de authenticatie en een statusindicator ‘Ingeschakeld’ of ‘Uitgeschakeld’
De pagina ‘Webhooks’. Elke rij geeft weer hoe vaak de webhook is aangeroepen, hoe de aanroepers zich authenticeren en of deze is ingeschakeld; via het menu aan de rechterzijde kunt u de webhook inschakelen, uitschakelen of verwijderen.