Referral Event Object


Properties
idstringRead-onlyformat GUID

Referral event ID.


revisionintegerformat int64

Revision number, which increments by 1 each time the referral event is updated. To prevent conflicting changes, the current revision must be passed when updating the referral event.


createdDatestringRead-onlyformat date-time

Date and time the referral event was created.


updatedDatestringRead-onlyformat date-time

Date and time the referral event was last updated.


ONE OF:

referredFriendSignupEventReferredFriendSignupEvent

Event triggered when a referred friend signs up.


successfulReferralEventSuccessfulReferralEvent

Event triggered when a referral is successful. For example, customer places and pays for an order.


actionEventActionEvent

Event triggered when an action is performed. For example, placing an order.


rewardEventRewardEvent

Event triggered when a reward is given.

ReferralEvent
JSON
{ "referralEvent": { "id": "017fad99-aa0f-47a9-8d4f-177fc6a07da3", "revision": "1", "createdDate": "2024-07-08T11:22:00.826Z", "updatedDate": "2024-07-08T11:22:00.826Z", "rewardEvent": { "referralRewardId": "c8c732cf-2ca2-4025-9b1c-3be02f099cdb", "rewardType": "COUPON", "rewardedReferringCustomerId": "4fb41de4-da9c-4818-b54f-82c955ecc866" } } }
Did this help?