Webhooks
Yurplan vous offre des possibilités quasi illimitées grâce aux webhooks !
Une fois configuré, un webhook permettra à Yurplan de vous envoyer vos données automatiquement via une requête HTTP(S) vous permettant ainsi de réagir à différent cas survenant au cours du cycle de vie de votre événement.
💡Chaque webhook est associé à un déclencheur qui possède des données spécifiques.
Commande validée et Modifiée
Dès qu'un participant s'inscrit à votre évènement, modifie ses données personnelles ou ses éventuels ateliers, vous recevrez les données suivantes :
{
"trigger": "ORDER_VALIDATED",
"version": 1,
"data": {
"event": {
"name": "John Doe Corp. Annual Meeting",
"identifier": "ca612025-ebaf-4651-b13f-27975aaeafc6"
},
"total": {
"amount": "100.00",
"currency": "EUR"
},
"payment_reference": "YPTB0000057814",
"payment_method": "CB_ONLINE",
"buyer": {
"first_name": "John",
"last_name": "Doe",
"email_address": "john.doe@yurplan.invalid"
},
"answers": [
{
"answer": ["69001"],
"question": "Code postal"
},
{
"answer": ["John"],
"question": "Prénom"
},
{
"answer": ["Doe"],
"question": "Nom"
}
],
"tickets": [
{
"token": "256617431735685270",
"answers": [
{
"answer": ["01/01/2000"],
"question": "Date d'anniversaire"
},
{
"answer": [null],
"question": "Adresse postale"
},
{
"answer": [null],
"question": "Genre"
}
],
"last_name": "Doe",
"first_name": "John",
"identifier": "cce2fb2f-ba1e-4efa-905e-e90014974781",
"ticket_type": {
"name": "Simple",
"amount": "10.00",
"identifier": "72283cad-eec3-4942-8be6-00a27b78b387"
},
"email_address": "john.doe@yurplan.invalid"
},
{
"token": "3747892655358460",
"answers": [
{
"answer": ["01/02/2000"],
"question": "Date d'anniversaire"
},
{
"answer": ["1 Rue de la République Lyon 69001 France"],
"question": "Adresse postale"
},
{
"answer": ["Femme"],
"question": "Genre"
}
],
"last_name": "Doe",
"first_name": "Jane",
"identifier": "f03db27b-8f37-4230-b435-46d35fb94842",
"ticket_type": {
"name": "Simple",
"amount": "10.00",
"identifier": "72283cad-eec3-4942-8be6-00a27b78b387"
},
"email_address": "jane.doe@yurplan.invalid"
}
],
"identifier": "1db5b8e5-ca2f-4a33-bd32-98beb3a4830d",
"payment_date": "2020-01-01T11:00:00Z"
}
}
Commande créée
Dès qu'une commande est enregistrée sur votre événement, indépendamment de l'existence ou non d'un paiement associé (qu'elle soit payée, partiellement payée, ou sans paiement préalable), vous recevrez les données suivantes :
💡 À noter : Le format des données transmises reste identique à celui du webhook de Commande validée et Modifiée pour faciliter votre intégration. Cependant, pour les commandes avec un paiement différé ou sans paiement au moment de la création :
- Le champ
payment_methodrenverra la valeurnull. - Le champ
payment_daterenverra la valeurnull. - Le champ de référence de paiement (
payment_reference) sera toujours renseigné afin d'assurer la continuité de votre suivi.
{
"trigger": "ORDER_CREATED",
"version": 1,
"data": {
"event": {
"name": "John Doe Corp. Annual Meeting",
"identifier": "ca612025-ebaf-4651-b13f-27975aaeafc6"
},
"total": {
"amount": "100.00",
"currency": "EUR"
},
"payment_reference": "YPTB0000057814",
"payment_method": null,
"buyer": {
"first_name": "John",
"last_name": "Doe",
"email_address": "john.doe@yurplan.invalid"
},
"answers": [
{
"answer": ["69001"],
"question": "Code postal"
},
{
"answer": ["John"],
"question": "Prénom"
},
{
"answer": ["Doe"],
"question": "Nom"
}
],
"tickets": [
{
"token": "256617431735685270",
"answers": [
{
"answer": ["01/01/2000"],
"question": "Date d'anniversaire"
},
{
"answer": [null],
"question": "Adresse postale"
},
{
"answer": [null],
"question": "Genre"
}
],
"last_name": "Doe",
"first_name": "John",
"identifier": "cce2fb2f-ba1e-4efa-905e-e90014974781",
"ticket_type": {
"name": "Simple",
"amount": "10.00",
"identifier": "72283cad-eec3-4942-8be6-00a27b78b387"
},
"email_address": "john.doe@yurplan.invalid"
}
],
"identifier": "1db5b8e5-ca2f-4a33-bd32-98beb3a4830d",
"payment_date": null
}
}
Scan d'un billet
Dès qu'un de vos participants sera scanné grâce à nos applications dédiées, vous recevrez les données suivantes :
{
"trigger": "ATTENDEE_CHECKED_IN",
"version": "1",
"data": {
"check": {
"direction": "IN",
"scan_date": "2020-01-01T12:00:00Z"
},
"event": {
"name": "John Doe Corp. Annual Meeting",
"identifer": "ca612025-ebaf-4651-b13f-27975aaeafc6"
},
"ticket": {
"token": "3747892655358460",
"last_name": "Doe",
"first_name": "Jane",
"identifier": "f03db27b-8f37-4230-b435-46d35fb94842",
"ticket_type": {
"name": "Simple",
"identifier": "72283cad-eec3-4942-8be6-00a27b78b387"
},
"email_address": "jane.doe@yurplan.invalid"
},
"scanlist": {
"name": "Global"
},
"checked_by": {
"last_name": "Doe",
"first_name": "John"
}
}
}
Élément de commande annulé
Lorsqu'une commande a un élément (billet ou produit) annulé, les données suivantes vous seront envoyées :
{
"trigger": "ORDER_ITEM_CANCELED",
"version": "1",
"data": {
"identifier": "d90ba818-c962-327e-8b06-5cc7926f2a41",
"type": "ticket",
"orderItemType": {
"identifier": "028ec65d-3270-4e69-aa31-f7462b765369",
"type": "ticket",
"label": "SIMPLE TICKET",
"originalPrice": {
"amount": "20.0",
"currency": "EUR"
},
"vatRate": "30.0"
},
"amount": {
"amount": "20.0",
"currency": "EUR"
},
"event": {
"identifier": "d4e54233-fa3d-153b-83ae-201e00ed1909",
"name": "Opening Day"
}
}
}
Le Webhooks est une fonctionnalité Premium, activable depuis l'interface de configuration de votre événement.
Rendez vous dans l'onglet Gérer mes applications > Développeur, puis cliquez sur Activer.
