Win Events & Custom Events

LinkBridge supports two main types of events: Win Events (sales, revenue-related) and Custom Events (user actions you define). These events help you measure conversions, analyze funnels, and gain a detailed picture of user behavior.

API Config - Sales Events

Think of this secret key as your backstage pass to our system—it's how you let us know about a new sale. When you send us an event, make sure the eventType is set to win_xxx (because winning is what we're all about) and include the saleAmount (so we can do the math). If the format isn't just right, the event won't count as a sale, and nobody wants to miss out on a win! So, keep it simple, follow the rules, and let's make some magic happen!

POST https://app.linkbridge.click/api/secure/events
Headers: {
  "Authorization": "Bearer YOUR_SECRET_KEY",
  "Content-Type": "application/json"
}

Request Body:
{
  "eventType": "win_sale", // e.g. win_sale, win_purchase
  "websiteId": "68ab108c4a215929683ad3b9",
  "visitorId": "extract from the __visitorId cookie",
  "sessionId": "extract from the __sessionId cookie",
  "data": {
    "saleAmount": 149.99,
    "saleId": "ORD-9921",
    "saleCurrency": "USD"
  }
}

API Config - Custom Events

Custom events let you track specific user actions (e.g. login, checkout step, button clicks). They can be sent from both backend and frontend, but must include identifiers for tracking.

POST https://app.linkbridge.click/api/secure/events
Headers: {
  "Authorization": "Bearer YOUR_SECRET_KEY",
  "Content-Type": "application/json"
}

Request Body:
{
  "eventType": "custom_checkout_step",
  "visitorId": "<extract from __visitorId cookie>",
  "sessionId": "<extract from __sessionId cookie>",
  "websiteId": "68ab108c4a215929683ad3b9",
  "data": {
    "step": 2,
    "funnel": "checkout"
  }
}

API Config - Visitor Enrichment

Enrich visitor profiles with additional information such as email, name, company, tags, and custom metadata. This data helps you segment and analyze your audience more effectively. The visitor ID should match the one from your tracking cookies.

POST https://app.linkbridge.click/api/visitor/{visitorId}
Headers: {
  "Authorization": "Bearer YOUR_SECRET_KEY",
  "Content-Type": "application/json"
}

Request Body:
{
  "websiteId": "507f1f77bcf86cd799439011",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "company": "Acme Corp",
  "tags": ["premium", "enterprise"],
  "plan": "pro",
  "signupDate": "2024-01-15",
}