Skip to main content
The campaign.shared event is triggered when a user shares a campaign link to a social platform or directly. The payload contains details about the share operation and the campaign. 
{
  "id": "evt_...",
  "event": "campaign.shared",
  "timestamp": "2024-08-26T16:41:52.346Z",
  "data": {
    "share": {
      "id": "shr_...",
      "campaignId": "cm11...",
      "campaignName": "Summer Referral Push",
      "userId": "usr_...",
      "userName": "John Doe",
      "userEmail": "john@example.com",
      "userImage": "https://example.com/avatar.jpg",
      "postId": "post_...",
      "postUrl": "https://linkedin.com/posts/...",
      "platform": "linkedin",
      "timestamp": "2024-08-26T16:41:52.346Z",
      "method": "direct",
      "createdAt": "2024-08-26T16:41:52.346Z"
    },
    "campaign": {
      "id": "cm11...",
      "name": "Summer Referral Push",
      "shareContext": "Check out this amazing opportunity!",
      "objective": "increase_awareness",
      "description": "Our main summer campaign",
      "domain": "heyoo.ai",
      "destinationUrl": "https://heyoo.ai/summer",
      "utm_source": "heyoo",
      "utm_medium": "referral",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "ref": null,
      "clicks": 0,
      "shares": 1,
      "targetShares": 100,
      "startDate": "2024-06-01T00:00:00.000Z",
      "endDate": "2024-08-31T23:59:59.999Z",
      "shareRewardAmount": 10,
      "clickRewardAmount": 1,
      "rewardType": "points",
      "maxRewardPerEmployee": 500,
      "totalBudget": 5000,
      "consumedBudget": 0,
      "minimumClicksForReward": 5,
      "uniqueClicksOnly": true,
      "status": "active",
      "creatorId": "usr_...",
      "workspaceId": "ws_...",
      "workspaceSlug": "acme",
      "contentPillarName": "Promotions",
      "createdAt": "2024-08-26T16:40:00.000Z",
      "updatedAt": "2024-08-26T17:00:00.000Z"
    }
  }
}