Dashboard

referrals/completed

Triggered when a referral process has completed.

A referral process is considered completed once the friend has completed an order with either the discount code awarded from starting a referral or using the email which they submitted to start the referral process.

Topic

referrals/completed

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
    }
}