Webhooks

Een gebeurtenis in VoordeMensen triggert een actie in een ander systeem

Door een webhook in te stellen roept VoordeMensen externe URL's aan, elke keer dat er een bepaalde actie plaatsvindt. Die URL's kun je zelf instellen, en je kan heel precies aangeven welke gegevens uit VoordeMensen moeten worden meegestuurd.

Zo kun je nieuwe bestellingen automatisch laten binnenlopen in je eigen CRM, gewijzigde klantgegevens bijwerken of na elke bestelling een Philips Hue-lamp laten knipperen.

Hoe de andere systemen reageren op de webhook zul je zelf in die systemen moeten instellen. Dat bevindt zich buiten het blikveld van VoordeMensen.

Instellen

In het VoordeMensen Dashboard kun je een onbeperkt aantal webhooks instellen. We ondersteunen op dit moment twee triggers: een nieuwe bestelling en een wijziging van de klantgegevens. Wanneer die acties plaatsvinden wordt het URL aangeroepen en de JSON payload meegestuurd (via de POST-methode).

Payload

In de payload geef je aan welke gegevens precies moeten worden meegestuurd. Daarbij kun je variabelen gebruiken die als het ware worden "gemail-merged" voordat de actie wordt uitgevoerd.

In het geval van een nieuwe bestelling kun je gebruiken:

• %ORDER% - voor een compleet Order object

• %USER% - voor een compleet User object

• %SEATS% - voor een array met Seats behorende bij de bestelling

In het geval van gewijzigde klantgegevens kun je alleen de %USER% tag gebruiken.

Daarnaast zijn alle velden uit de objecten ook los aanroepbaar, zonder hun voorloper in snake_case te gebruiken, op de id's na. Zoals bovenstaand te zien is bijvoorbeeld:

• %ORDER_ID% en %USER_ID% voor de unieke id's

• %FIRSTNAME% %PREPOSITION% %LASTNAME% voor de naamgeving

• %EMAIL% voor het e-mailadres

• %PAYMENT_STATUS% voor de betaalstatus

• %MAILINGLIST% voor een boolean waarbij wel of geen e-mail opt-in is gekozen