Webhooks: Use cases for integrating with events generated by YouLi

 

See API specification here.

Payments Trigger

Example of a the JSON provided to the webhook when subscribed to 

TIP: If you need to know which installment was paid, check the Allocations (one level down from the payment level). Note that it it is a catch-up payment (many instalments) then no installment value will be provided.

 

{    "Id": "bb2bb801-8eee-4051-8444-04f0beebed62",    "FullName": "Example Invitee",    "FirstName": "Example",    "LastName": "Invitee",    "Email": null,    "PhoneNumber": null,    "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",    "MiniBio": null,    "RegistrationStatus": 1,    "RegistrationDateReceivedUTC": "2022-06-01T23:59:35.7534074Z",    "RegistrationNote": null,    "ResponseDietaryRequirement": null,    "PlannerNote": null,    "InvitationGroup": null,    "InvitationGroupMembers": [        {            "FullName": "Example Invitee",            "FirstName": "Example",            "LastName": "Invitee",            "Email": null        }    ],    "NumberInGroup": 1,    "PackageName": null,    "BasePrice": 0.0,    "Room": null,    "TripId": "52a93c5f-be80-e711-a964-06949f7015aa",    "TripName": "Sample of bank transfer",    "TripAlias": "sample-of-bank-transfer",    "TripRegistrationButtonLabel": "YES",    "MagicLink": "https://staging.youli.io/t/bronthulke/sample-of-bank-transfer/2de6e3a0-8e39-4e32-ab3e-14f825ccf478",    "TrackingSource": null,    "TrackingMedium": null,    "TrackingCampaign": null,    "Payment": {        "Id": "ad0757b5-7d93-4610-995d-30589bb927be",        "Amount": 100.0,        "Currency": "USD",        "Method": "offline",        "Description": "Sample payment",        "Status": "successful",        "PaymentDateUTC": "2022-06-01T23:59:35.7534074Z",        "YouLiFeeAmount": 0.0,        "YouLiFeeCurrency": null,        "CreditCardSurchargeAmount": 0.0,        "CreditCardSurchargeCurrency": "USD",        "RefundProtectSurchargeAmount": 0.0,        "RefundProtectSurchargeCurrency": "USD",        "Allocations": [            {                "Id": "00000000-0000-0000-0000-000000000000",                "FullName": "Example Invitee",                "FirstName": "Example",                "LastName": "Invitee",                "Amount": 100.0,                "Installment": null            }        ]    }}