Links

Events that fire when a tracked link is clicked.

Events that fire when a tracked link is clicked.

Events

EventWhen it fires
link.clickA contact clicks a tracked Whippy link.

Examples

Each example is the full POST body Whippy sends, including the envelope fields data, api_version, event, created_at, and request_id.

link.click

A contact clicks a tracked Whippy link.

{
  "data": {
    "contact": {
      "email": "[email protected]",
      "external_id": null,
      "id": "db737fac-9b54-48ba-9fdc-7db30f907fab",
      "name": "Bruce Wayne",
      "phone": "+14244023950"
    },
    "link": {
      "id": "a7089736-33d8-41d7-a399-39adcbccb3ee",
      "link_setting": {
        "custom_card_description": "Earn competitive compensation and make a significant impact. Click on thhe link for more details",
        "custom_card_image": {
          "content_type": "image/jpeg",
          "url": "https://1.bp.blogspot.com/_J9PlRvGGXS8/Su46nKRk_wI/AAAAAAAABZQ/d73kC45JkGw/s400/batman-avatar-10.jpg"
        },
        "custom_card_title": "Join the Our Team!",
        "description": null,
        "id": "2c12f24b-5a99-4ad9-89ab-f0c75e6fb7e3",
        "status": "active",
        "url": "https://whippy.ai/products/campaigns",
        "use_custom_card": true,
        "utm_campaign": "hire_forklift_drivers",
        "utm_content": "join_our_team",
        "utm_medium": "sms-campaign",
        "utm_source": "whippy",
        "utm_term": "forklift_drivers"
      },
      "short_key": "8KR5eJgh",
      "short_url": "http://whippy.pro/8KR5eJgh",
      "url": "https://whippy.ai/products/campaigns"
    },
    "metadata": {
      "campaign_id": null,
      "conversation_id": "11c31817-bd97-4244-9341-e4252c0194d0",
      "created_at": "2024-03-06T19:32:07.851011Z",
      "message_id": "ce44715f-999f-49ed-a7b4-90a9bf1b699f",
      "sequence_id": null,
      "step_id": null,
      "tracking_data": {
        "domain": "whippy.pro",
        "geolocation": {
          "as": "AS28573 Claro NXT Telecomunicacoes Ltda",
          "asname": "Claro NXT Telecomunicacoes Ltda",
          "city": "Sorocaba",
          "continent": "South America",
          "continent_code": "SA",
          "country": "Brazil",
          "country_code": "BR",
          "currency": "BRL",
          "district": "unknown",
          "hosting": false,
          "isp": "Claro NXT Telecomunicacoes Ltda",
          "lat": -23.4996,
          "lon": -47.4518,
          "message": null,
          "mobile": false,
          "offset": -10800,
          "org": "NET Serviços de Comunicação S.A.",
          "proxy": false,
          "query": "187.180.185.177",
          "region": "SP",
          "region_name": "Sao Paulo",
          "reverse": "bbb4bda7.virtua.com.br",
          "status": "success",
          "timezone": "America/Sao_Paulo",
          "zip": "18000"
        },
        "referrer": null,
        "referrer_url": null,
        "user_agent": {
          "browser_family": "Firefox",
          "client": {
            "engine": "Gecko",
            "engine_version": "123.0",
            "name": "Firefox",
            "type": "browser",
            "version": "123.0"
          },
          "device": {
            "brand": "unknown",
            "model": "unknown",
            "type": "desktop"
          },
          "os": {
            "name": "Windows",
            "platform": "x64",
            "version": "10"
          },
          "os_family": "Windows",
          "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:123.0) Gecko/20100101 Firefox/123.0"
        }
      }
    }
  },
  "api_version": "v1",
  "event": "link.click",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "f77c42b6-d26c-5bb3-acc9-d24ad21b791a"
}

Did this page help you?