Events

📘

Some Events are dependent on certain features being enabled.

For instance, Events focussing on NPS or Propensity to Refer require Campaigns for NPS or Smart Experiments to be being actively promoted to Customers respectively.

If you'd like to know more about these features, please speak to your Account Manager.

Events are all the different types of actions Customers can do, which can be subscribed to by external systems.

These events underpin many of our most central Customer actions, like when a Referrer is Registered, or a Referee receives their reward. And can intern drive functionality in your external systems.

For instance, you may wish to update a customer record when a customer successfully refers their friend, send out an email when a customer receives a reward for referring, or apply credit to an account in real-time when a reward is received.

Examples

Referrer has been registered (webhook/registration/referrer)

This event occurs whenever a customer is registered as a referrer. This may be a silent enrollment, and does not require that the referrer actively interacts with the journey.

It is up to you to determine if you can contact this customer with marketing messages.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/registration/referrer",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.982+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "customerOffer": {
          "id": 105,
          "createdDate": "2020-04-03T09:39:08+01:00",
          "expiryDate": "2020-07-03T09:39:08+01:00",
          "segment": "",
          "situation": "postpurchase",
          "shareLink": "https://demo.mention-me.com/m/ol/ka2bu-ryder-collins",
          "dashboardLink": "https://demo.mention-me.com/d/55/1c9925260de8cc0c5d1f5398af9624a3ff798e754dba5891587c2f545ec9192f"
      },
      "customer": {
          "customerId": "MI9795903142",
          "email": "[email protected]",
          "firstname": "Ryder",
          "surname": "Collins",
          "metrics": {
              "successfulReferrals": 7,
              "shareCount": {
                  "all": 8,
                  "byWhatsApp": 2,
                  "byFacebook": 1,
                  "byFacebookMessenger": 0,
                  "byName": 2,
                  "byEmailLink": 1,
                  "byNativeShare": 0
              }
          }
      },
      "campaign": {
          "id": 233023,
          "shortName": "Campaign",
          "locale": {
              "id": 323691,
              "localeCode": "en_GB",
              "shortName": "English UK",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 712100,
          "name": "Experiment",
          "variationCount": 1,
          "isPromotion": false
      },
      "offer": {
          "id": 70171,
          "shortName": "Variation",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 0,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "rewards": [
          {
              "id": 54182,
              "fulfilledBy": "coupon",
              "amount": 250,
              "referrerReward": "$250",
              "refereeReward": "20%",
              "discountReward": null,
              "spendConstraint": 1000,
              "minimumFriendsRequired": 0,
              "description": "Referrer gets $250 off when they spend over $1000",
              "type": "amount"
          }
      ]
  }
}
Referrer has engaged during registration (webhook/registration/referrer_engaged)

This event occurs whenever a customer actively engages with the referral journey during registration.

It is up to you to determine if you can contact this customer with marketing messages.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/registration/referrer_engaged",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.983+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "customerOffer": {
          "id": 105,
          "createdDate": "2020-04-03T09:39:08+01:00",
          "expiryDate": "2020-07-03T09:39:08+01:00",
          "segment": "",
          "situation": "postpurchase",
          "shareLink": "https://demo.mention-me.com/m/ol/ka2bu-ryder-collins",
          "dashboardLink": "https://demo.mention-me.com/d/55/1c9925260de8cc0c5d1f5398af9624a3ff798e754dba5891587c2f545ec9192f"
      },
      "customer": {
          "customerId": "MI9795903142",
          "email": "[email protected]",
          "firstname": "Ryder",
          "surname": "Collins",
          "metrics": {
              "successfulReferrals": 7,
              "shareCount": {
                  "all": 8,
                  "byWhatsApp": 2,
                  "byFacebook": 1,
                  "byFacebookMessenger": 0,
                  "byName": 2,
                  "byEmailLink": 1,
                  "byNativeShare": 0
              }
          }
      },
      "campaign": {
          "id": 233023,
          "shortName": "Campaign",
          "locale": {
              "id": 323691,
              "localeCode": "en_GB",
              "shortName": "English UK",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 712100,
          "name": "Experiment",
          "variationCount": 1,
          "isPromotion": false
      },
      "offer": {
          "id": 70171,
          "shortName": "Variation",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 0,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "rewards": [
          {
              "id": 54182,
              "fulfilledBy": "coupon",
              "amount": 250,
              "referrerReward": "$250",
              "refereeReward": "20%",
              "discountReward": null,
              "spendConstraint": 1000,
              "minimumFriendsRequired": 0,
              "description": "Referrer gets $250 off when they spend over $1000",
              "type": "amount"
          }
      ]
  }
}
Referee has been registered (webhook/registration/referee)

This event occurs whenever a referee provides their email address to confirm they have been referred by a friend.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/registration/referee",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.982+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "referee": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "",
          "surname": "",
          "marketingOptIn": true,
          "phoneNumbers": ["+447927275988"],
          "isVoid": false,
          "id": 193,
          "shareSource": "WHATSAPP"
      },
      "referrer": {
          "id": 53137,
          "customerId": "MI9795903142",
          "email": "[email protected]",
          "firstname": "Ryder",
          "surname": "Collins",
          "referrerIsUnknown": false,
          "segment": "VIP",
          "metrics": {
              "successfulReferrals": 7,
              "shareCount": {
                  "all": 8,
                  "byWhatsApp": 2,
                  "byFacebook": 1,
                  "byFacebookMessenger": 0,
                  "byName": 2,
                  "byEmailLink": 1,
                  "byNativeShare": 1
              }
          }
      },
      "campaign": {
          "id": 14660,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13268,
          "name": "Experiment 1",
          "variationCount": 1,
          "isPromotion": false
      },
      "offer": {
          "id": 86237,
          "shortName": "Variation 1",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 0,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "reward": {
          "id": 44137,
          "fulfilledBy": "coupon",
          "amount": 20,
          "referrerReward": "20%",
          "refereeReward": "20%",
          "discountReward": null,
          "type": "percent",
          "description": "Referee gets 20% off",
          "beforePurchase": true
      }
  }
}
Referrer metrics has been updated (webhook/metric/referrer)

This event occurs whenever a customer's behaviour results in their referrer metrics to have. For example, they they actively share, or when their friend signs up.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/metric/referrer",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.983+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "referrer": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Kirk",
          "surname": "Begby",
          "segment": "mock-segment"
      },
      "metrics": {
          "successfulReferrals": 7,
          "shareCount": {
              "all": 8,
              "byWhatsApp": 2,
              "byFacebook": 1,
              "byFacebookMessenger": 0,
              "byName": 2,
              "byEmailLink": 1,
              "byNativeShare": 0
          },
          "firstShareDate": "2023-10-23T16:13:21+01:00",
          "lastShareDate": "2023-10-23T16:49:09+01:00",
          "firstReferralDate": "2023-10-23T15:26:29+01:00",
          "lastReferralDate": "2023-10-24T08:59:19+01:00"
      },
      "campaign": {
          "id": 14679,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13355,
          "name": "Experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86438,
          "shortName": "Variation 1",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 1,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "customerOffer": {
          "id": 105,
          "createdDate": "2020-04-03T09:39:08+01:00",
          "expiryDate": "2020-07-03T09:39:08+01:00",
          "segment": "",
          "situation": "postpurchase",
          "shareLink": "https://demo.mention-me.com/m/ol/ka2bu-ryder-collins",
          "dashboardLink": "https://demo.mention-me.com/d/55/1c9925260de8cc0c5d1f5398af9624a3ff798e754dba5891587c2f545ec9192f"
      },
  }
}
Marketing consent has been given (webhook/marketing/consent)

This event occurs whenever a customer consents to receiving marketing messages from your brand (e.g. for a newsletter).

The option to consent to marketing is only presented to referees when they are signing up after being referred by a friend.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/marketing/consent",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.984+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "customer": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Kirk",
          "surname": "Begby",
          "marketingOptIn": true,
          "phoneNumbers": ["+447927275988"]
      },
      "campaign": {
          "id": 14679,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13355,
          "name": "Experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86438,
          "shortName": "Variation 1",
          "type": "incentive",
          "summary": "25% off when they sign up to newsletter",
          "variation": 1,
          "content": {
              "referrer": {
                  "headline": null,
                  "cta": null
              },
              "incentive": {
                  "headline": "Get 20% off when you make another purchase",
                  "cta": "Get 20% off"
              }
          }
      },
      "marketing": {
          "source": "newsletter-signup"
      }
  }
}
Incentive for Action has been fulfilled (webhook/fulfillment/incentive_for_action)

This event occurs whenever an action, separate from referral, is completed to earn an individual a reward (e.g. signing up for a newsletter).

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/fulfillment/incentive_for_action",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.981+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "reward": {
          "id": 200021,
          "callToActionUrl": null,
          "fulfilledBy": "coupon",
          "amount": 20,
          "referrerReward": null,
          "refereeReward": null,
          "discountReward": "£20",
          "description": "Referrer gets 20% off",
          "type": null,
          "expiryDate": "2025-09-03T12:40:18+01:00"
      },
      "campaign": {
          "id": 555960,
          "shortName": "Campaign",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 600340,
          "name": "Experiment",
          "variationCount": 1,
          "isPromotion": false
      },
      "incentivee": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname"
      },
      "offer": {
          "id": 810477,
          "shortName": "Variation",
          "type": "incentive",
          "summary": "Ifa gets 20% off",
          "variation": 1,
          "offerTermsUrl": "https://mentionme.dev/me/terms/123456/abcdef",
          "content": {
              "referrer": {
                  "headline": null,
                  "cta": null
              },
              "incentive": {
                  "headline": "Get 20% off when you make another purchase",
                  "cta": "Get 20% off"
              }
          }
      }
  }
}
Referrer has been fulfilled (webhook/fulfillment/referrer)

This event occurs whenever a customer earns a reward for referring their friend, e.g. because a Referee has completed a purchase.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/fulfillment/referrer",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.981+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "reward": {
          "id": 23674,
          "callToActionUrl": null,
          "fulfilledBy": "coupon",
          "amount": 33,
          "referrerReward": "£33",
          "refereeReward": "20%",
          "discountReward": null,
          "type": "amount",
          "description": "Referrer gets £33 off",
          "couponCode": "example-coupon-123",
          "minimumFriendsRequired": 1,
          "maximumFriendsRequired": 1,
          "expiryDate": "2025-09-03T12:40:18+01:00"
      },
      "campaign": {
          "id": 14679,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13355,
          "name": "Experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86438,
          "shortName": "Variation 1",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 1,
          "offerTermsUrl": "https://mentionme.dev/me/terms/123456/abcdef",
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "referees": [
          {
              "customerId": "abc123xyz321",
              "email": "[email protected]",
              "firstname": "Firstname",
              "surname": "Surname"
          }
      ],
      "referrer": {
          "id": 53137,
          "customerId": "abc123xyz321",
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname",
          "referrerIsUnknown": false,
          "segment": "VIP",
          "metrics": {
              "successfulReferrals": 7,
              "shareCount": {
                  "all": 8,
                  "byWhatsApp": 2,
                  "byFacebook": 1,
                  "byFacebookMessenger": 0,
                  "byName": 2,
                  "byEmailLink": 1,
                  "byNativeShare": 0
              }
          }
      }
  }
}
Referee has been fulfilled (webhook/fulfillment/referee)

This event occurs whenever a customer earns a reward for being referred by their friend.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/fulfillment/referee",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.981+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "reward": {
          "id": 23668,
          "callToActionUrl": "https://demo.mention-me.com/ac/admin/client/merchants/add",
          "fulfilledBy": "coupon",
          "amount": 20,
          "referrerReward": "20%",
          "refereeReward": "20%",
          "discountReward": null,
          "type": "percent",
          "description": "Referee gets 20% off",
          "beforePurchase": true,
          "couponCode": "example-coupon-123",
          "expiryDate": "2025-09-03T12:40:18+01:00"
      },
      "campaign": {
          "id": 14679,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13355,
          "name": "Experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86438,
          "shortName": "Variation 1",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 1,
          "offerTermsUrl": "https://mentionme.dev/me/terms/123456/abcdef",
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "referee": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname",
          "isVoid": false,
          "phoneNumbers": ["+447927275988"],
          "id": 36,
          "shareSource": "WHATSAPP"
      },
      "referrer": {
          "id": 36242,
          "customerId": "124124124124",
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname",
          "referrerIsUnknown": false,
          "segment": "VIP",
          "metrics": {
              "successfulReferrals": 7,
              "shareCount": {
                  "all": 8,
                  "byWhatsApp": 2,
                  "byFacebook": 1,
                  "byFacebookMessenger": 0,
                  "byName": 2,
                  "byEmailLink": 1,
                  "byNativeShare": 0
              }
          }
      }
  }
}
NPS feedback has been received (webhook/nps/feedback)

This event occurs whenever a customer submits qualitative feedback to an NPS survey.

The event will only occur for active NPS campaigns.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/nps/feedback",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.982+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "nps": {
          "id": 1,
          "situation": null,
          "segment": null,
          "answer": 2,
          "feedback": "Could have been better",
          "createdDate": "2025-08-27T12:40:18.982+01:00"
      },
      "customer": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname"
      },
      "campaign": {
          "id": 14733,
          "shortName": "1st order campaign",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13479,
          "name": "1st order experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86664,
          "shortName": "NPS leading to referral or incentive",
          "type": "nps-referral-incentive",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 1,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      }
  }
}
NPS score has been received (webhook/nps/score)

This event occurs whenever a customer submits an NPS score, before providing qualitative feedback.

The event will only occur for active NPS campaigns.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/nps/score",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.982+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "nps": {
          "id": 1,
          "situation": "postpurchase",
          "segment": null,
          "answer": 8,
          "createdDate": "2025-08-27T12:40:18.982+01:00"
      },
      "customer": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname"
      },
      "campaign": {
          "id": 14733,
          "shortName": "1st order campaign",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13479,
          "name": "1st order experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86664,
          "shortName": "NPS leading to referral or incentive",
          "type": "nps-referral-incentive",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 1,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      }
  }
}
Propensity to Refer segment has been updated (webhook/propensity_to_refer/segment)

This event occurs whenever a Propensity To Refer score is requested and potentially updated.

The score is only calculated for active Smart Experiments.

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/propensity_to_refer/segment",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.983+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "customer": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "Kirk",
          "surname": "Begby"
      },
      "campaign": {
          "id": 14679,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13355,
          "name": "Experiment 1",
          "variationCount": 4,
          "isPromotion": false
      },
      "offer": {
          "id": 86438,
          "shortName": "Variation 1",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 1,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "propensity": {
          "segment": "High"
      }
  }
}
Referee qualification has started (webhook/qualification_start/referee)

This event occurs whenever a referee completes a transaction, signs up or completes a booking, which confirms they were introduced by their friend successfully.

It is the first step before the referee (and referrer) are eventually rewarded (or cancelled).

{
  "meta": {
      "domain": "demo.mention-me.com",
      "type": "webhook/qualification_start/referee",
      "isTest": true,
      "triggeredAt": "2025-08-27T12:40:18.984+01:00",
      "uuid": "139fe691-1819-42ee-b7de-49a458e90c43",
      "version": "1"
  },
  "merchant": {
      "id": 0,
      "slug": "",
      "partnerCode": ""
  },
  "payload": {
      "referee": {
          "customerId": null,
          "email": "[email protected]",
          "firstname": "",
          "surname": "",
          "isVoid": false,
          "phoneNumbers": ["+447927275988"],
          "id": 193,
          "shareSource": "WHATSAPP"
      },
      "campaign": {
          "id": 14660,
          "shortName": "Campaign 1",
          "locale": {
              "id": 1,
              "localeCode": "en_GB",
              "shortName": "English (UK)",
              "languageCode": "en",
              "currencyCode": "GBP",
              "currencySymbol": "£"
          },
          "state": "Running"
      },
      "experiment": {
          "id": 13268,
          "name": "Experiment 1",
          "variationCount": 1,
          "isPromotion": false
      },
      "offer": {
          "id": 86237,
          "shortName": "Variation 1",
          "type": "referral",
          "summary": "Referrer gets £10 off. Referee gets 15% off",
          "variation": 0,
          "content": {
              "referrer": {
                  "headline": "Treat a friend to 15% off and get £10 off for yourself",
                  "cta": "Get £10 off"
              },
              "incentive": {
                  "headline": null,
                  "cta": null
              }
          }
      },
      "order": {
          "id": 123456,
          "currency": "GBP",
          "total": 97.98,
          "orderDate": "2020-09-08T11:14:55+00:00",
          "confirmedBy": "Matt Stevens"
      },
      "referrer": {
          "id": 53137,
          "customerId": "abc123xyz321",
          "email": "[email protected]",
          "firstname": "Firstname",
          "surname": "Surname",
          "referrerIsUnknown": false,
          "segment": "VIP",
          "metrics": {
              "successfulReferrals": 7,
              "shareCount": {
                  "all": 8,
                  "byWhatsApp": 2,
                  "byFacebook": 1,
                  "byFacebookMessenger": 0,
                  "byName": 2,
                  "byEmailLink": 1,
                  "byNativeShare": 0
              }
          }
      },
      "reward": {
          "id": 44137,
          "fulfilledBy": "coupon",
          "amount": 20,
          "referrerReward": "20%",
          "refereeReward": "20%",
          "discountReward": null,
          "type": "percent",
          "description": "Referee gets 20% off",
          "waitPeriodDays": 5,
          "requiresApproval": true
      }
  }
}