Skip to main content
The campaign.clicked event is triggered when a user clicks on a shared campaign link. The payload includes details about the click, the campaign, and the sharer. 
{
  "id": "evt_...",
  "event": "campaign.clicked",
  "timestamp": "2024-08-26T16:41:52.346Z",
  "data": {
    "click": {
      "id": "clk_...",
      "timestamp": "2024-08-26T16:41:52.346Z",
      "url": "https://heyoo.ai/summer?ref=...",
      "country": "US",
      "city": "San Francisco",
      "region": "CA",
      "continent": "NA",
      "device": "mobile",
      "browser": "Chrome",
      "os": "iOS",
      "referer": "linkedin.com",
      "refererUrl": "https://www.linkedin.com/",
      "qr": false,
      "ip": "192.168.1.1"
    },
    "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": 1,
      "shares": 10,
      "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"
    },
    "sharer": {
      "id": "usr_...",
      "name": "John Doe",
      "email": "john@example.com"
    }
  }
}