Hoe u Square kunt koppelen aan Shopify Flow
Square verstuurt een Webhook voor betalingen, bestellingen, terugbetalingen, klanten en voorraadwijzigingen via zowel zijn kassa- als onlineproducten. Workflow Webhooks zet die oproep om in een trigger voor de ‘Shopify Flow’, zodat uw winkel hierop kan reageren: een klant labelen, een opmerking bij een bestelling toevoegen, een interne e-mail versturen, een metaveld bijwerken - alles wat Shopify Flow kan doen.
Deze handleiding beschrijft het volledige proces - Square verzendt, Workflow Webhooks ontvangt en controleert, Shopify Flow voert de actie uit - waarbij bij elk verzoek de HMAC-handtekening van Square wordt gecontroleerd, zodat uitsluitend Square uw workflow kan starten.
Wat u kunt bouwen
- Tag een klant van Shopify die via Square een aankoop heeft gedaan in uw fysieke winkel.
- Voeg een opmerking toe aan een klant wanneer er een Square-terugbetaling wordt uitgevoerd, zodat de support het volledige beeld heeft.
- Stuur een e-mail naar het personeel wanneer de voorraad in Square voor een gedeelde SKU onder een drempelwaarde daalt.
Voorbeelden van gebeurtenissen die u kunt doorgeven: payment.created, refund.updated, customer.created, inventory.count.updated.
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 Square 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, zoals
Square events. - Kies onder ‘Authenticatie’ de optie ‘HMAC’.
- Kies onder ‘Signature provider’ voor Square. 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 Square
Open in het Square Developer Dashboard het gedeelte ‘Webhooks’ van uw applicatie, voeg een abonnement toe met de URL die u hebt gekopieerd en kopieer de handtekeningsleutel.
Hoe u uw Square-aanmeldingsgeheim kunt vinden
De Signature-sleutel van het webhook-abonnement (Square Developer Dashboard -> Webhooks).
In de documentatie van Square 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 Square-levering geverifieerd voordat deze Shopify Flow bereikt.
Wat hiermee wordt gecontroleerd
| Wat | Waarde |
|---|---|
| Handtekeningkoptekst | x-square-hmacsha256-signature |
| Waar de handtekening staat | De volledige waarde van de header |
| Wat is ondertekend? | {url}{body} |
| Handtekening | HMAC-SHA256, gecodeerd met Base64 |
| Tijdstempel | Wordt niet gebruikt door deze afzender |
| 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 is {url} de URL van deze webhook.
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 Square (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 ervoor te zorgen dat deze workflow uitsluitend voor Square geldt. 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.
Stap 4 - Test het van begin tot eind
Activeer een daadwerkelijke gebeurtenis in Square. 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 te zien, en op Gecertificeerde webhooks verifiëren vindt u uitleg over de handtekeningtester die u precies laat zien welke stap is mislukt.
De handtekening komt niet overeen▾
In deze volgorde: 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 Square en de app staat dat de hoofdtekst 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 Square geselecteerd, of het geheim is ingevuld en of Square 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 Square en bekijk het eigen afleveringslogboek van Square 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 in de workflow een voorwaarde toe op basis van de webhook-ID, of beperk de gebeurtenissen die u vanuit Square 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 Square een levering opnieuw probeert uit te voeren.
- Geschiedenis en probleemoplossing - het logboek van elk verzoek, inclusief de mogelijkheid tot herhaling.