Referral completed

Topic: v1/customer/referralCompleted

Payload example:

{
    "timestamp": "2024-05-27T06:34:39.662Z",
    "referred": {
        "email": "referred@gmail.com",
        "phone": null,
        "shopifyCustomerId": 5784483037270
    },
    "referrer": {
        "email": "referrer@gmail.com",
        "phone": null,
        "shopifyCustomerId": 5784483037269
    },
    "orderId": 5432109876543
}

Documentation table

Properties

timestampstring

Timestamp when the referral was completed in ISO 8601 format.

referredobject

Customer identifier details of the referred customer.

referrerobject

Customer identifier details of the referrer customer.

orderIdnumber

Shopify order ID of the qualifying purchase that completed the referral.

The timestamp remains unchanged when Growave retries to resend it.