Een webhook is een soort API die een bericht zal versturen naar een ingestelde (externe) url. Er zijn verschillende momenten waarop zo'n bericht verstuurd kan worden: dankzij webhooks kan je dus "inhaken" op een specifieke actie.
Acties
Momenteel zijn volgende acties beschikbaar:- Bestelling uitgevoerd
- Barcode gescanned
Van zodra bv een bestelling wordt uitgevoerd zal de gekozen url die ingesteld is in de webhook aangeroepen worden. Dit zowel bij een automatische actie (bv na bestelling uitgevoerd na betaling van de bestelling) als een manuele actie door de gebruiker in de admin (bv ticket manueel scannen).
Logica
- Tickoweb verwacht een HTTP200 antwoord van de url
- Indien er geen of een ander antwoord ontvangen zou worden, zal de webhook opnieuw worden uitgevoerd na respectievelijk: 3, 9, 27, 81 en 243 minuten. Ontvangen we na de laatste poging geen antwoord zal de webhook definitief worden gesloten en niet meer herhaald worden.
- De webhook bevat, afhankelijk van de gekozen actie, de data van het object in JSON formaat. De definitie volgt het OpenAPI schema, beschikbaar op https://openapi.tickoweb.be/v1. Bv voor de actie "bestelling uitgevoerd" zal het schema "Order" worden verzonden naar de ingestelde URL.