import { TrackLeadRequestBody } from "dub/models/operations";
let value: TrackLeadRequestBody = {
clickId: "<id>",
eventName: "Sign up",
};| Field | Type | Required | Description | Example |
|---|---|---|---|---|
clickId |
string | ✔️ | The ID of the click in Dub. You can read this value from dub_id cookie. |
|
eventName |
string | ✔️ | The name of the lead event to track. | Sign up |
eventQuantity |
number | ➖ | The numerical value associated with this lead event (e.g., number of provisioned seats in a free trial). If defined as N, the lead event will be tracked N times. | |
externalId |
string | ➖ | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | |
customerId |
string | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. |
|
customerName |
string | ➖ | Name of the customer in the client's app. | |
customerEmail |
string | ➖ | Email of the customer in the client's app. | |
customerAvatar |
string | ➖ | Avatar of the customer in the client's app. | |
metadata |
Record<string, any> | ➖ | Additional metadata to be stored with the lead event | |
mode |
operations.Mode | ➖ | The mode to use for tracking the lead event. async will not block the request; wait will block the request until the lead event is fully recorded in Dub. |