Events

Below are sample request payloads you will receive based on the webhook event types you have selected for your account.

1. Referrer / Affiliate Created Description: When a new referrer/affiliate is added to the campaign (includes direct signups, signup via API/SDK, and participants added/imported via admin dashboard)

2. Referee Created Description: When a new referee is added to the campaign (includes direct signups, signup via API/SDK, and participants added/imported via admin dashboard)

3. Participant unlocked a Reward Description: When a participant becomes elgibile for a reward

{
  "eventType": "referrer_added",
  "data": {
    "participantId": 384,
    "firstName": "",
    "lastName": "",
    "email": "[e-mail]",
    "code": "scG3q9Ez",
    "campaignId": "PMf8BDZ1zb",
    "referredByCode": null,
    "referralReward": 0,
    "referralRewardBalance": 0,
    "referralRewardRedeemed": 0,
    "refereeReward": 0,
    "refereeRewardBalance": 0,
    "refereeRewardRedeemed": 0,
    "refereeActionCompleted": false,
    "refereeActionCompletedLabel": null,
    "rewardType": null,
    "rewardCurrency": "USD",
    "createdOn": "2025-02-09T03:00:28.002+00:00",
    "updatedOn": "2025-02-09T03:00:28.002+00:00",
    "approval": true,
    "totalReferred": 0,
    "totalCompletedReferred": 0,
    "amountPaid": 0,
    "paymentCount": 0,
    "revenueGenerated": 0,
    "rewardDue": 0,
    "rewardPaid": 0,
    "score": "Low",
    "impressionCount": 0
  },
  "createdAt": 1739070028207,
  "updatedAt": 1739070028207
}