Event Types

Available events

Event	Triggers when
link.clicked	A user clicks any deep link in your Appspace
deferred_link.claimed	A user opens the app after a deferred deep link install
install.tracked	The Tolinku SDK reports a new app install
referral.created	A new referral is created via the API or SDK
referral.completed	A referral reaches its reward milestone
ecommerce.purchase	A purchase event is recorded
ecommerce.refund	A refund event is recorded
ecommerce.cart_abandoned	A cart is detected as abandoned (begin_checkout with no purchase within the configured window)
ecommerce.add_to_cart	A user adds an item to their cart
ecommerce.begin_checkout	A user starts the checkout process
ecommerce.add_to_wishlist	A user adds an item to their wishlist
ecommerce.fraud_flagged	An ecommerce event is flagged by fraud detection rules

Payload format

Every webhook delivery has the same top-level structure:

{
  "event": "link.clicked",
  "timestamp": "2026-03-02T14:30:00.000Z",
  "data": { }
}

• event: The event type string (matches the table above).
• timestamp: ISO 8601 datetime in UTC.
• data: Event-specific fields (see below).

Event payloads

link.clicked

Sent when a user taps or clicks a deep link.

{
  "event": "link.clicked",
  "timestamp": "2026-03-02T14:30:00.000Z",
  "data": {
    "url": "https://your-app.tolinku.com/promo/summer",
    "prefix": "/promo",
    "token": "summer",
    "country": "US",
    "device_type": "mobile",
    "os": "iOS",
    "browser": "Safari",
    "platform": "ios",
    "campaign": "summer-promo",
    "source": "instagram"
  }
}

deferred_link.claimed

Sent when a user installs the app through a deferred deep link and opens it for the first time. The SDK reports the original link data.

{
  "event": "deferred_link.claimed",
  "timestamp": "2026-03-02T14:35:00.000Z",
  "data": {
    "url": "https://your-app.tolinku.com/invite/room-abc",
    "prefix": "/invite",
    "token": "room-abc",
    "platform": "ios"
  }
}

install.tracked

Sent when the SDK reports a new app install.

{
  "event": "install.tracked",
  "timestamp": "2026-03-02T14:32:00.000Z",
  "data": {
    "platform": "android",
    "country": "GB",
    "device_type": "mobile",
    "os": "Android"
  }
}

referral.created

Sent when a new referral entry is created.

{
  "event": "referral.created",
  "timestamp": "2026-03-02T15:00:00.000Z",
  "data": {
    "referral_code": "SARAH2026",
    "referrer_id": "user_456",
    "referral_url": "https://your-app.tolinku.com/ref/SARAH2026"
  }
}

referral.completed

Sent when a referral reaches its reward milestone (e.g. the referred user completes a purchase).

{
  "event": "referral.completed",
  "timestamp": "2026-03-02T16:00:00.000Z",
  "data": {
    "referral_code": "SARAH2026",
    "referrer_id": "user_456",
    "referred_user_id": "user_789",
    "milestone": "completed",
    "reward_type": "credit",
    "reward_value": "500",
    "referee_reward_type": "discount",
    "referee_reward_value": "10"
  }
}

ecommerce.purchase

Sent when a purchase event is recorded.

{
  "event": "ecommerce.purchase",
  "timestamp": "2026-03-02T17:00:00.000Z",
  "data": {
    "transaction_id": "order_456",
    "user_id": "user_123",
    "revenue": 49.99,
    "currency": "USD",
    "items_count": 2,
    "coupon_code": "SAVE10"
  }
}

ecommerce.refund

Sent when a refund event is recorded.

{
  "event": "ecommerce.refund",
  "timestamp": "2026-03-02T18:00:00.000Z",
  "data": {
    "transaction_id": "order_456",
    "user_id": "user_123",
    "revenue": 49.99,
    "currency": "USD"
  }
}

ecommerce.cart_abandoned

Sent when a cart is detected as abandoned. The abandonment detection job runs hourly and checks for begin_checkout events without a subsequent purchase within the configured window.

{
  "event": "ecommerce.cart_abandoned",
  "timestamp": "2026-03-02T19:00:00.000Z",
  "data": {
    "user_id": "user_123",
    "cart_id": "cart_abc",
    "checkout_timestamp": "2026-03-02T14:30:00.000Z",
    "hours_since_checkout": 4.5
  }
}

ecommerce.fraud_flagged

Sent when an ecommerce event is flagged by fraud detection rules (severity 1). Blocked events (severity 2) are silently rejected and do not trigger webhooks.

{
  "event": "ecommerce.fraud_flagged",
  "timestamp": "2026-03-02T20:00:00.000Z",
  "data": {
    "event_type": "purchase",
    "transaction_id": "order_789",
    "user_id": "user_suspicious",
    "revenue": 9999.99,
    "rule": "impossible_revenue",
    "severity": 1
  }
}