A referral process is considered started when the customer's friend submits their email address. The webhook body includes the referral activity as well as any related rewards for the referral activity.

Topic

referrals/started

Webhook Body

{
    id: string,
    customer: {
        "id": string,
        "externalId": string,
        "email": string,
        "name": string,
        "birthdayMonth": integer,
        "birthdayDay": integer,
        "referralUrl": string,
        "pointBalance": integer,
        "currentLoyaltyTier": {
            "id": string,
            "title": string
        },
        "createdAt": date,
        "updatedAt": date
    },
    friendCustomer: {
        "id": string,
        "externalId": string,
        "email": string,
        "name": string,
        "birthdayMonth": integer,
        "birthdayDay": integer,
        "referralUrl": string,
        "pointBalance": integer,
        "currentLoyaltyTier": {
            "id": string,
            "title": string
        },
        "createdAt": date,
        "updatedAt": date
    },
    friendEmail: string,
    customerReward: {
        "id": string,
        "couponCode": string,
        "couponCodeStatus": string,
        "discountType": string,
        "discountAmount": float
    },
    friendReward: {
        "id": string,
        "couponCode": string,
        "couponCodeStatus": string,
        "discountType": string,
        "discountAmount": float
    }
}