POST
/
track
/
lead
import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.track.lead();

  // Handle the result
  console.log(result);
}

run();
{
  "click": {
    "id": "<string>"
  },
  "customer": {
    "name": "<string>",
    "email": "<string>",
    "avatar": "<string>",
    "externalId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Body

application/json
​
clickId
string
required

The ID of the click in th Dub. You can read this value from dub_id cookie.

Minimum length: 1
​
eventName
string
required

The name of the event to track.

Required string length: 1 - 50
Example:

"Sign up"

​
externalId
string
default:

This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.

Maximum length: 100
​
customerId
string | null
deprecated

This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.

Maximum length: 100
​
customerName
string | null

Name of the customer in the client's app.

Maximum length: 100
​
customerEmail
string | null

Email of the customer in the client's app.

Maximum length: 100
​
customerAvatar
string | null

Avatar of the customer in the client's app.

Maximum length: 100
​
metadata
object | null

Additional metadata to be stored with the lead event

Response

200
application/json
A lead was tracked.
​
click
object
required
​
customer
object
required

Was this page helpful?

Suggest edits