Skip to main content
Deze pagina bevat alle webhook-events die beschikbaar zijn in storekit, gegroepeerd per categorie.

Order-events

Events gerelateerd aan de levenscyclus en het beheer van bestellingen.
storekit stuurt geen order.accepted- of order.rejected-event. Na order.created.v2 is het volgende event dat je voor een bestelling ontvangt de eerste statuswijziging (order.preparing, order.ready_for_pickup, order.out_for_delivery, order.completed of order.canceled).

order.created.v2

Wordt geactiveerd wanneer een klant een nieuwe bestelling plaatst. Dit is het event waarop je je moet abonneren voor nieuwe bestellingen.

order.created

Het legacy-event voor nieuwe bestellingen. Het bevat dezelfde ordervelden als order.created.v2, maar verzendt ze als top-level-body zonder event- of data-wrapper:
Beide events worden voor elke nieuwe bestelling verzonden. Abonneer je op order.created.v2 zodat je handler de standaard payload-structuur ontvangt die door elk ander event wordt gebruikt. order.created blijft beschikbaar voor bestaande integraties.

order.canceled

Wordt geactiveerd wanneer een bestelling wordt geannuleerd.

order.preparing

Wordt geactiveerd wanneer een bestelling overgaat naar de status ‘in voorbereiding’.

order.ready_for_pickup

Wordt geactiveerd wanneer een bestelling wordt gemarkeerd als klaar om door de klant te worden opgehaald.

order.out_for_delivery

Wordt geactiveerd wanneer een bezorgorder wordt verzonden.

order.completed

Wordt geactiveerd wanneer een bestelling wordt gemarkeerd als afgerond. Dit vuurt zowel voor individuele orderafrondingen (via het dashboard, Deliverect, iKentoo of automatische update) als voor bulkafrondingen.

order.pos.dispatch.failed

Wordt geactiveerd wanneer een bestelling niet naar een POS-systeem kan worden verzonden.

order.rating.updated

Wordt geactiveerd wanneer een klant een beoordeling voor zijn bestelling indient of bijwerkt.

order.refund.created, order.refund.succeeded, order.refund.failed

order.refund.created vuurt wanneer er vanuit het dashboard een refund wordt uitgegeven; order.refund.succeeded of order.refund.failed volgt zodra de payment gateway het verwerkt. Alle drie delen één vorm en, in tegenstelling tot andere events, staan de velden naast event in plaats van binnen data:
customer.id en refund.reason zijn null wanneer ze niet beschikbaar zijn.

Store-events

Events gerelateerd aan storestatus en -configuratie.

store.opened

Wordt geactiveerd wanneer een store wordt geopend, wanneer een snooze vroegtijdig wordt beëindigd of wanneer een tijdgebonden snooze automatisch verloopt.

store.closed

Wordt geactiveerd wanneer een store wordt gesloten of gesnoozed.
closedReason en closedUntil zijn lege strings wanneer de store zonder reden of eindtijd is gesloten.

store.opening_hours.updated

Wordt geactiveerd wanneer openingstijden voor een store worden gewijzigd, vanuit het dashboard of door een POS-sync.

Item-events

Events gerelateerd aan beschikbaarheid van menu-items.

item.out_of_stock

Wordt geactiveerd wanneer een menu-item niet meer beschikbaar is. Dit kan via verschillende routes gebeuren:
  • Handmatige snooze — een beheerder snoozet het item vanuit het dashboard
  • Handmatig uitschakelen — een beheerder zet de beschikbaarheid van het item op uit
  • Voorraad opgebruikt — de voorraad van het item bereikt nul na een bestelling
  • Integratiesync — een POS of integratie (Deliverect, Lightspeed, Zonal) markeert het item als niet beschikbaar
Het reason-veld geeft aan waarom het item niet meer op voorraad is, en source geeft aan wat het heeft geactiveerd.
Het details-object verschilt per reden:
  • snoozed — bevat snoozeEnd (ISO 8601-timestamp, of null voor onbepaalde snoozes)
  • inventory_depleted — leeg {}
  • disabled — leeg {}

Payments-events

Events gerelateerd aan betalingen en uitbetalingen.

payments.payout.created

Wordt geactiveerd wanneer storekit een uitbetaling naar je bankrekening verstuurt.
estimatedArrivalDate is een maand/jaar-string, of een lege string wanneer de uitbetalingsprovider er geen heeft opgegeven. Wordt geactiveerd wanneer een nieuwe payment link wordt aangemaakt. Wordt alleen gevuurd voor accounts met webhooks ingeschakeld.
Wordt geactiveerd wanneer een betaling succesvol wordt geïncasseerd via een payment link. Wordt alleen gevuurd voor accounts met webhooks ingeschakeld.
Wordt geactiveerd wanneer een refund wordt gestart voor een payment link-betaling. De refund is op dit moment nog in behandeling — bevestiging komt via payment_link.refund.succeeded of payment_link.refund.failed zodra de payment gateway hem asynchroon verwerkt.
Wordt geactiveerd wanneer de payment gateway bevestigt dat een refund succesvol is verwerkt. Dit vuurt asynchroon na payment_link.refund.created.
Wordt geactiveerd wanneer de payment gateway een refund afwijst. Dit vuurt asynchroon na payment_link.refund.created.

Printer-events

Events gerelateerd aan de status van cloudprinters.

printer.status.offline

Wordt geactiveerd wanneer een verbonden cloudprinter zich gedurende 5 minuten niet meldt bij de storekit-server. Er wordt ook een e-mailmelding gestuurd naar het geconfigureerde e-mailadres van de venue.
Een printer die door meerdere stores wordt gedeeld verstuurt één event per store.

printer.status.online

Wordt geactiveerd wanneer een cloudprinter opnieuw verbinding maakt met onze servers na minstens 5 minuten offline te zijn geweest. Er wordt ook een e-mailmelding gestuurd om te bevestigen dat de printer weer online is.