Event Spec

Why the Converge Spec?

Most CDPs are not very strict about which events you track, where you track them (client or server) and with which properties. This usually leads to problems with destinations downstream as each destination does have very specific integration requirements to operate optimally.

Advantages of a strict spec

Converge, therefore, works with a strict Converge event spec. Because we have a semantic understanding of what you are tracking, we can:

Automatically map your source events to destinations in an optimal way through our
Surface your meaningful analytics through our product.
Monitor and flag when you are wrongly tracking events or properties negatively affecting your destinations or analytics through .

Of course, you can still extend the Converge Spec with your own events, properties, etc.

Auto-tracking

These events, event properties, profile properties and aliases will be auto-tracked by the Converge Pixel.

$page_load

When a user views a page.

Where To Track

This event should be tracked on the client.

Code Example

cvg({ method: "track", eventName: "$page_load" });

You do not need to manually implement any of the below properties, they will be automatically tracked for all client-side events.

Auto-tracked Event Properties

string

IP address of the user.

string

URL of the pageview.

string

URL referrer of the pageview.

string

Browser timezone.

string

Viewport size of the pageview.

string

The sales channel where the event occurred. For client-side events tracked through the Converge Pixel, this will always be “web” by default. More on supported sales channels can be found here.

Auto-tracked Profile Properties

string

IP address of the user.

Converge cookie ID.

string

User Agent of the last browser session of the user.

Auto-tracked Aliases

Alias based on the Converge cookie ID.

Ecommerce events

These events and properties should be passed for Ecommerce brands. All of these events will contain additional prepopulated properties through auto-tracking.

Viewed Product

When a user views a product detail page.

Where To Track

This event should be tracked on the client.

Event Properties

string

required

Product ID of the item that is being viewed.

string

Variant ID of the product variant that is being viewed

string

SKU of the product and variant that is being viewed

string

required

Product Name of the item that is being viewed

string

Variant name of the product variant that is being viewed

float

required

Unit price of the item that is being viewed

string

required

Currency of the product that is being viewed, as per ISO 4217

string

Name of the vendor of the product that is being viewed.

string

URL to the product page of the item that is being viewed.

string

URL of a product image of the item that is being viewed.

Code Example

cvg({
  method: "track",
  eventName: "Viewed Product",
  properties: {
    product_id: "123456",
    variant_id: "78910", // if available
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla", // if available
    price: 42,
    currency: "USD",
    vendor: "My Store",
  },
});

Viewed Collection

When a user views a collection detail page that includes multiple products.

Where To Track

This event should be tracked on the client.

Event Properties

string

required

Collection ID of the collection that is being viewed.

string

required

Name of the collection that is being viewed.

string

Description of the collection that is being viewed.

list of Item

Show Item

string

required

Product ID of the item that is being viewed.

string

Variant ID of the product variant that is being viewed

string

SKU of the product and variant that is being viewed

string

required

Product Name of the item that is being viewed

string

Variant name of the product variant that is being viewed

float

required

Unit price of the item that is being viewed

string

required

Currency of the product that is being viewed, as per ISO 4217

string

Name of the vendor of the product that is being viewed.

string

URL to the product page of the item that is being viewed.

string

URL of a product image of the item that is being viewed.

Code Example

cvg({
  method: "track",
  eventName: "Viewed Collection",
  properties: {
    id: "123456", // Collection ID
    name: "My Collection Name",
    description: "My Collection Description",
    items: [
      {
        product_id: "123456",
        variant_id: "78910", // if available
        sku: "MY_SKU",
        name: "My Product",
        variant_name: "Vanilla", // if available
        price: 42,
        currency: "USD",
        vendor: "My Store",
      },
    ],
  },
});

Added To Cart

When a user adds a product to cart.

Where To Track

This event should be tracked on the client.

Event Properties

string

required

Product ID of the item that is being added to cart.

string

Variant ID of the product variant that is being added to cart.

string

SKU of the product and variant that is being added to cart.

string

required

Product Name of the item that is being added to cart.

string

Variant name of the product variant that is being added to cart.

float

required

Unit price of the item that is being added to cart.

string

required

Currency of the product that is being viewed, as per ISO 4217

int

required

Amount of times the item is being added to cart.

string

Name of the vendor of the product that is being added to cart.

string

URL to the product page of the item that is being added to cart.

string

URL of a product image of the product that is being added to cart.

Code Example

cvg({
  method: "track",
  eventName: "Added To Cart",
  properties: {
    product_id: "123456",
    variant_id: "78910",
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla",
    price: 42,
    currency: "USD",
    quantity: 1,
    vendor: "My Store",
  },
});

Removed From Cart

When a user removes a product from cart.

Where To Track

This event should be tracked on the client.

Event Properties

string

required

Product ID of the item that is being removed from cart.

string

Variant ID of the product variant that is being removed from cart.

string

SKU of the product and variant that is being removed from cart.

string

required

Product Name of the item that is being removed from cart.

string

Variant name of the product variant that is being removed from cart.

float

required

Unit price of the item that is being removed from cart.

string

required

Currency of the product that is being viewed, as per ISO 4217

int

required

Amount of times the item is being removed from cart.

string

Name of the vendor of the product that is being removed from cart.

string

URL to the product page of the item that is being removed from cart.

string

URL of a product image of the product that is being removed from cart.

Code Example

cvg({
  method: "track",
  eventName: "Removed From Cart",
  properties: {
    product_id: "123456",
    variant_id: "78910",
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla",
    price: 42,
    currency: "USD",
    quantity: 1,
    vendor: "My Store",
  },
});

Started Checkout

When a user starts the checkout process.

This event typically is used for stitching website sessions to server-side orders, make sure to add appropriate aliases

Where To Track

This event should be tracked on the client.

Event Properties

float

required

Total value of the cart at checkout with tax and shipping.

float

required

Total tax of the cart at checkout.

float

required

Total shipping cost of the cart at checkout.

float

Total discount of the cart at checkout.

string | list of string

The coupon or list of coupons used at checkout

string

required

Currency of the cart that is being checked out, as per ISO 4217

list of CheckoutItem

Show CheckoutItem

string

required

Product ID of the item.

string

Variant ID of the product variant

string

SKU of the product and variant

string

required

Product Name of the item

string

Variant name of the product variant

float

required

Unit price of the item

string

required

Currency of the product, as per ISO 4217

string

Name of the vendor of the product.

int

required

Amount of times the item is present in the cart at checkout.

string

URL to the product page of the item

string

URL of a product image of the item

Code Example

cvg({
  method: "track",
  eventName: "Started Checkout",
  properties: {
    total_price: 42,
    total_tax: 3.5,
    total_shipping: 2.4,
    currency: "USD",
    coupon: 'COUPON123',
    items: [
      // Notice that this is a list of items
      {
        product_id: "123456",
        variant_id: "78910",
        sku: "MY_SKU",
        name: "My Product",
        variant_name: "Vanilla",
        price: 42,
        currency: "USD",
        quantity: 1,
        vendor: "My Store",
      },
    ],
  },
  aliases: ["urn:cart_token:xyz123"]
});

Added Payment Info

When a user adds their payment info.

This event typically is used for stitching website sessions to server-side orders, make sure to add appropriate aliases

Where To Track

This event should be tracked on the client.

Event Properties

float

required

Total value of the cart at checkout with tax and shipping.

float

required

Total tax of the cart at checkout.

float

required

Total shipping cost of the cart at checkout.

float

Total discount of the cart at checkout.

string | list of string

The coupon or list of coupons used at checkout

string

required

Currency of the cart that is being checked out, as per ISO 4217

list of CheckoutItem

Show CheckoutItem

string

required

Product ID of the item.

string

Variant ID of the product variant

string

SKU of the product and variant

string

required

Product Name of the item

string

Variant name of the product variant

float

required

Unit price of the item

string

required

Currency of the product, as per ISO 4217

string

Name of the vendor of the product.

int

required

Amount of times the item is present in the cart at checkout.

string

URL to the product page of the item

string

URL of a product image of the item

Profile Properties

string

required

Email Address of the user.

string

Phone Number of the user including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the user’s address.

string

Country code of the user’s address according to ISO 3166.

string

State of the user’s address.

string

Zip code of the user’s address.

Code Example

cvg({
  method: "track",
  eventName: "Added Payment Info",
  properties: {
    total_price: 42,
    total_tax: 3.5,
    total_shipping: 2.4,
    currency: "USD",
    coupon: 'COUPON123',
    items: [
      {
        product_id: "123456",
        variant_id: "78910",
        sku: "MY_SKU",
        name: "My Product",
        variant_name: "Vanilla",
        price: 42,
        currency: "USD",
        quantity: 1,
        vendor: "My Store",
      },
    ],
  },
  profileProperties: {
    // Pass if available
    $email: "john.smith@apple.com",
    $phone_number: "+199999999",
    $city: "San Francisco",
    $country_code: "US",
    $state: "California",
    $zip_code: "94103",
  },
  
  // important, this will be used for stitching backend orders to website sessions
  aliases: ["urn:email:john.smith@apple.com"],
});

Placed Order

When a user places an order.

Conversion event: you should adhere to the Where To Track, Deduplication and Session Stitching guidelines.

Where To Track

This event should be tracked on both the client and the server.

Deduplication

You should pass a unique eventID so client-side and server-side copies of the same order can be deduplicated.

Session Stitching

You should make sure that the conversion can be stitched to the corresponding website session by including the right set of aliases on this event and corresponding web events.Common aliases are:

Email: urn:email:john.smith@apple.com
Checkout Token: urn:checkout_token:xyz_123
Customer ID: urn:customer_id:123456

Which alias you use depends on your exact setup and which identifiers are available both on the browser and the server in a user journey.Learn more about session stitching and aliases here.

Event Properties

string

required

Order ID.

float

required

Total value of the order with tax and shipping.

float

required

Total tax of the order.

float

required

Total shipping cost of the order.

float

Total discount on the order.

string | list of string

The coupon or list of coupons used in the order.

string

required

Currency of the order, as per ISO 4217

list of CheckoutItem

Show CheckoutItem

string

required

Product ID of the item in the order.

string

Variant ID of the item in the order

string

SKU of the item in the order

string

required

Product Name of the item in the order

string

Variant name of the product variant

float

required

Unit price of the item in the order

string

required

Currency of the item in the order, as per ISO 4217

string

Name of the vendor of the item in the order.

int

required

Amount of times the item is present in the order.

string

URL to the product page of the item

string

URL of a product image of the item

boolean

required

Whether this order is the customer’s first completed purchase. If omitted, Converge falls back to its own order history. See New customer status for more details, including override behavior and common pitfalls.

string

The sales channel of the event. If no sales channel type is provided then Converge fallback to “web”. More on supported sales channels values can be found here. The sales channel type provided entirely depends on the context of the event, integration, and where the event originates from. Client-side Placed Order events should always be “web”.

string

The URL of the page where the event occurred. This will be automatically tracked for all client-side events.

Profile Properties

Some fields are required for both the Event Properties and the Profile Properties. The reason is that Event Properties are static and Profile Properties are dynamic. A customer might move address between two orders for example.

string

required

Email Address of the user.

string

Phone Number of the user including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the user’s address.

string

Country code of the user’s address according to ISO 3166.

string

State of the user’s address.

string

Zip code of the user’s address.

Code Example

If you track conversions both server-side and client-side, you should make sure you use the "forward" method for the client-side event. See the client-side code example.Make sure you include the same eventID on the client-side and server-side event.

Note that client-side calls use camelCase (e.g. eventName) and server-side calls use snake_case (e.g. event_name).

cvg({
  method: "forward", 
  eventName: "Placed Order",
  eventID: "order-1", // used for deduplicating, should be unique
  properties: {
    id: "order-1",
    total_price: 42,
    total_tax: 3.5,
    total_shipping: 2.4,
    currency: "USD",
    coupon: 'COUPON123',
    items: [
      {
        product_id: "123456",
        variant_id: "654321",
        sku: "MY_SKU",
        name: "My Product",
        variant_name: "Vanilla",
        price: 42,
        currency: "USD",
        quantity: 1,
        vendor: "My Store",
      },
    ],
  },
  profileProperties: {
    // Pass if available
    $email: "john.smith@apple.com",
    $phone_number: "+199999999",
    $city: "San Francisco",
    $country_code: "US",
    $state: "California",
    $zip_code: "94103",
},
  aliases: ["urn:email:john.smith@apple.com"],
});

resp = requests.post(
    "https://app.runconverge.com/api/webhooks",
    header={
      "Content-Type": "application/json", 
      "X-Webhook-Token": "{YOUR_WEBHOOK_TOKEN}"
    },
    json=
        {
        "event_name": "Placed Order",
        "event_id": "order-1", # your order id, necessary for deduplication
        "properties": {
            "id" : "order-1", # will be shown in the UI
            "total_price": 42,
            "total_tax": 3.5,
            "total_shipping": 2.4,
            "currency": "USD",
            "items": [
                {
                    "product_id": "123456",
                    "variant_id": "654321", # important for Shopify stores
                    "sku": "MY_SKU",
                    "name": "My Product",
                    "variant_name": "Vanilla",
                    "price": 42,
                    "currency": "USD",
                    "quantity": 1,
                    "vendor": "My Store",
                },
            ],
            "$is_new_customer": False, # important
            "$sales_channel_type": "web",  # important, see supported sales channels
            "$url": "https://my-store.com/checkout"
        },
        "profile_properties": {
            # Pass as many as possible
            "$first_name": "John",
            "$last_name": "Smith",
            "$email": "john.smith@apple.com",
            "$phone_number": "+199999999",
            "$city": "San Francisco",
            "$country_code": "US",
            "$state": "California",
            "$zip_code": "94103",
        },
        # important, this will be used for stitching backend orders to website sessions
        "aliases": ["urn:email:john.smith@apple.com"],
    }
)

Viewed Cart

When a user views their cart.

This is an optional event

Where To Track

This event should be tracked on the client.

Event Properties

float

required

Total value of the cart with tax and shipping.

float

required

Total tax of the cart.

float

required

Total shipping cost of the cart.

float

Total discount of the cart.

string | list of string

The coupon or list of coupons used in the cart.

string

required

Currency of the cart that is being checked out, as per ISO 4217

list of CartItem

Show CartItem

string

required

Product ID of the item.

string

Variant ID of the product variant

string

SKU of the product and variant

string

required

Product Name of the item

string

Variant name of the product variant

float

required

Unit price of the item

string

required

Currency of the product, as per ISO 4217

string

Name of the vendor of the product.

int

required

Amount of times the item is present in the cart at checkout.

Code Example

cvg({
  method: "track",
  eventName: "Viewed Cart",
  properties: {
    total_price: 42,
    total_tax: 3.5,
    total_shipping: 2.4,
    currency: "USD",
    coupon: 'COUPON123',
    items: [
      // Notice that this is a list of items
      {
        product_id: "123456",
        variant_id: "78910",
        sku: "MY_SKU",
        name: "My Product",
        variant_name: "Vanilla",
        price: 42,
        currency: "USD",
        quantity: 1,
        vendor: "My Store",
      },
    ],
  },
});

Subscription lifecycle events

These events and properties should be passed by companies who operate on subscriptions.

Started Subscription

When a user starts a subscription.

Conversion event: you should adhere to the Where To Track, Deduplication and Session Stitching guidelines.

Where To Track

This event should be tracked on both the client and the server.

Deduplication

You should pass a unique eventID so client-side and server-side copies of the same order can be deduplicated.

Session Stitching

Email: urn:email:john.smith@apple.com
Checkout Token: urn:checkout_token:xyz_123
Customer ID: urn:customer_id:123456

Which alias you use depends on your exact setup and which identifiers are available both on the browser and the server in a user journey.Learn more about session stitching and aliases here.

Event Properties

float

required

Total value of the subscription with tax and shipping.

float

required

Total tax of the subscription.

float

Total shipping cost of the subscription.

float

Total discount on the subscription.

string | list of string

The coupon or list of coupons used in the subscription.

string

required

Currency of the subscription, as per ISO 4217

list of CheckoutItem

Show CheckoutItem

string

required

Product ID of the item in the subscription.

string

Variant ID of the item in the subscription

string

SKU of the item in the subscription

string

required

Product Name of the item in the subscription

string

Variant name of the item in the subscription

float

required

Unit price of the item in the subscription

string

required

Currency of the item in the subscription, as per ISO 4217

string

Name of the vendor of the item in the subscription.

int

required

Amount of times the item is present in the subscription.

string

Profile Properties

string

required

Email Address of the subscriber.

string

Phone Number of the subscriber including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the subscriber’s address.

string

Country code of the subscriber’s address according to ISO 3166.

string

State of the subscriber’s address.

string

Zip code of the subscriber’s address.

Code Example

If you track conversions both server-side and client-side, you should make sure you use the "forward" method for the client-side event. See the client-side code example.

cvg({
  method: "forward", 
  eventName: "Started Subscription",
  eventID: "order-1", // should be the subscription id or order id of the first purchase
  properties: {
    id: "order-1",
    total_price: 42,
    total_tax: 3.5,
    total_shipping: 2.4,
    currency: "USD",
    coupon: 'COUPON123',
    items: [
      {
        product_id: "123456",
        variant_id: "654321",
        sku: "MY_SKU",
        name: "My Product",
        variant_name: "Vanilla",
        price: 42,
        currency: "USD",
        quantity: 1,
        vendor: "My Store",
      },
    ],
  },
  profileProperties: {
    // Pass if available
    $email: "john.smith@apple.com",
    $phone_number: "+199999999",
    $city: "San Francisco",
    $country_code: "US",
    $state: "California",
    $zip_code: "94103",
  },
  // important, this will be used for stitching backend orders to website sessions
  aliases: ["urn:email:john.smith@apple.com"],
});

resp = requests.post(
    "{YOUR_POSTBACK_ENDPOINT}",
    json=
        {
        "event_name": "Started Subscription",
        "event_id": "order-1",  # should be the subscription id or order id of the first purchase
        "properties": {
            "id" : "order-1", # will be shown in the UI
            "total_price": 42,
            "total_tax": 3.5,
            "total_shipping": 2.4,
            "currency": "USD",
            "items": [
                {
                    "product_id": "123456",
                    "variant_id": "654321", # important for Shopify stores
                    "sku": "MY_SKU",
                    "name": "My Product",
                    "variant_name": "Vanilla",
                    "price": 42,
                    "currency": "USD",
                    "quantity": 1,
                    "vendor": "My Store",
                },
            ],
            "$sales_channel_type": "web",
        },
        "profile_properties": {
            # Pass as many as possible
            "$first_name": "John",
            "$last_name": "Smith",
            "$email": "john.smith@apple.com",
            "$phone_number": "+199999999",
            "$city": "San Francisco",
            "$country_code": "US",
            "$state": "California",
            "$zip_code": "94103",
        },   
        # important, this will be used for stitching backend orders to website sessions
        "aliases": ["urn:email:john.smith@apple.com"],
    }
)

Cancelled Subscription

When a user cancels a subscription.

Where To Track

This event should be tracked on the server.

Event Properties

float

required

Total value of the subscription with tax and shipping.

float

required

Total tax of the subscription.

float

Total shipping cost of the subscription.

float

Total discount on the subscription.

string | list of string

The coupon or list of coupons used in the subscription.

string

required

Currency of the subscription, as per ISO 4217

list of CheckoutItem

Show CheckoutItem

string

required

Product ID of the item in the subscription.

string

Variant ID of the item in the subscription

string

SKU of the item in the subscription

string

required

Product Name of the item in the subscription

string

Variant name of the item in the subscription

float

required

Unit price of the item in the subscription

string

required

Currency of the item in the subscription, as per ISO 4217

string

Name of the vendor of the item in the subscription.

int

required

Amount of times the item is present in the subscription.

string

The sales channel where the event occurred. Due to this event typically being server side, the sales channel type should be “offline”. More on supported sales channels can be found here.

Profile Properties

string

required

Email Address of the subscriber.

string

Phone Number of the subscriber including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the subscriber’s address.

string

Country code of the subscriber’s address according to ISO 3166.

string

State of the subscriber’s address.

string

Zip code of the subscriber’s address.

Code Example

resp = requests.post(
    "{YOUR_POSTBACK_ENDPOINT}",
    json=
        {
        "event_name": "Cancelled Subscription",
        "properties": {
            "id": "4001920", # the subscription id
            "total_price": 42,
            "total_tax": 3.5,
            "total_shipping": 2.4,
            "currency": "USD",
            "items": [
                {
                    "product_id": "123456",
                    "variant_id": "654321", # important for Shopify stores
                    "sku": "MY_SKU",
                    "name": "My Product",
                    "variant_name": "Vanilla",
                    "price": 42,
                    "currency": "USD",
                    "quantity": 1,
                    "vendor": "My Store",
                },
            ],
            "$sales_channel_type": "offline",
        },
        "profile_properties": {
            # Pass as many as possible
            "$first_name": "John",
            "$last_name": "Smith",
            "$email": "john.smith@apple.com",
            "$phone_number": "+199999999",
            "$city": "San Francisco",
            "$country_code": "US",
            "$state": "California",
            "$zip_code": "94103",
        },
        "aliases": ["urn:email:john.smith@apple.com"],
    }
)

Placed Recurring Subscription Order

When a user places a recurring subscription order.

Where To Track

This event should be tracked on the server.

Event Properties

float

required

Total value of the subscription with tax and shipping.

float

required

Total tax of the subscription.

float

Total shipping cost of the subscription.

float

Total discount on the subscription.

string | list of string

The coupon or list of coupons used in the subscription.

string

required

Currency of the subscription, as per ISO 4217

list of CheckoutItem

Show CheckoutItem

string

required

Product ID of the item in the subscription.

string

Variant ID of the item in the subscription

string

SKU of the item in the subscription

string

required

Product Name of the item in the subscription

string

Variant name of the item in the subscription

float

required

Unit price of the item in the subscription

string

required

Currency of the item in the subscription, as per ISO 4217

string

Name of the vendor of the item in the subscription.

int

required

Amount of times the item is present in the subscription.

string

The sales channel where the event occurred. Due to this event typically being server side, the sales channel type should be “subscription_contract”. More on supported sales channels can be found here.

Profile Properties

string

required

Email Address of the subscriber.

string

Phone Number of the subscriber including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the subscriber’s address.

string

Country code of the subscriber’s address according to ISO 3166.

string

State of the subscriber’s address.

string

Zip code of the subscriber’s address.

Code Example

resp = requests.post(
    "{YOUR_POSTBACK_ENDPOINT}",
    json=
        {
        "event_name": "Placed Recurring Subscription Order",
        "properties": {
            "id": "4001920", # the subscription id
            "total_price": 42,
            "total_tax": 3.5,
            "total_shipping": 2.4,
            "currency": "USD",
            "items": [
                {
                    "product_id": "123456",
                    "variant_id": "654321", # important for Shopify stores
                    "sku": "MY_SKU",
                    "name": "My Product",
                    "variant_name": "Vanilla",
                    "price": 42,
                    "currency": "USD",
                    "quantity": 1,
                    "vendor": "My Store",
                },
            ],
            "$sales_channel_type": "subscription_contract",
        },
        "profile_properties": {
            # Pass as many as possible
            "$first_name": "John",
            "$last_name": "Smith",
            "$email": "john.smith@apple.com",
            "$phone_number": "+199999999",
            "$city": "San Francisco",
            "$country_code": "US",
            "$state": "California",
            "$zip_code": "94103",
        },
        "aliases": ["urn:email:john.smith@apple.com"],
    }
)

Useful additional events

Most ad platforms rely on the email parameter being available on customer events. For that reason, you will want to capture events that pick up this parameter.

Logged In

When a user logs in.

This event typically is used for stitching website sessions to server-side orders, make sure to add appropriate aliases

Where To Track

This event should be tracked on the client.

Event Properties

This event does not require any event properties.

Profile Properties

string

required

Email Address of the user.

string

Phone Number of the user including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the user’s address.

string

Country code of the user’s address according to ISO 3166.

string

State of the user’s address.

string

Zip code of the user’s address.

Code Example

cvg({
  method: "track",
  eventName: "Logged In",
  profileProperties: {
    $email: "john.smith@apple.com",
    $phone_number: "+199999999",
    $city: "San Francisco",
    $country_code: "US",
    $state: "California",
    $zip_code: "94103",
  },
  
  // important, this will be used for stitching backend orders to website sessions
  aliases: ["urn:email:john.smith@apple.com"],
});

Searched

When a user performs a search on your website.

Where To Track

This event should be tracked on the client.

Event Properties

string

required

The search query entered by the user.

Code Example

cvg({
  method: "track",
  eventName: "Searched",
  properties: {
    query: "running shoes",
  },
});

Signed Up

When a user signs up.

This event typically is used for stitching website sessions to server-side orders, make sure to add appropriate aliases

Where To Track

This event should be tracked on the client.

Event Properties

This event does not require any event properties.

Profile Properties

string

required

Email Address of the user.

string

Phone Number of the user including the + sign and country code. For example: "+1 (917) 123-4567" or "+3295123456".

string

City of the user’s address.

string

Country code of the user’s address according to ISO 3166.

string

State of the user’s address.

string

Zip code of the user’s address.

Code Example

cvg({
  method: "track",
  eventName: "Signed Up",
  profileProperties: {
    $email: "john.smith@apple.com",
    $phone_number: "+199999999",
    $city: "San Francisco",
    $country_code: "US",
    $state: "California",
    $zip_code: "94103",
  },
  
  // important, this will be used for stitching backend orders to website sessions
  aliases: ["urn:email:john.smith@apple.com"],
});

Getting started

Implementation

Converge MCP

Sources

Destinations

Data Warehouse

Attribution

Insights & Dashboards

Marketing Sources

Data Management

Settings

Why the Converge Spec?

Advantages of a strict spec

Auto-tracking

$page_load

Ecommerce events

Viewed Product

Viewed Collection

Added To Cart

Removed From Cart

Started Checkout

Added Payment Info

Placed Order

Viewed Cart

Subscription lifecycle events

Started Subscription

Cancelled Subscription

Placed Recurring Subscription Order

Useful additional events

Logged In

Searched

Signed Up

​Why the Converge Spec?

​Advantages of a strict spec

​Auto-tracking

​$page_load

​Ecommerce events

​Viewed Product

​Viewed Collection

​Added To Cart

​Removed From Cart

​Started Checkout

​Added Payment Info

​Placed Order

​Viewed Cart

​Subscription lifecycle events

​Started Subscription

​Cancelled Subscription

​Placed Recurring Subscription Order

​Useful additional events

​Logged In

​Searched

​Signed Up

Why the Converge Spec?

Advantages of a strict spec

Auto-tracking

$page_load

Ecommerce events

Viewed Product

Viewed Collection

Added To Cart

Removed From Cart

Started Checkout

Added Payment Info

Placed Order

Viewed Cart

Subscription lifecycle events

Started Subscription

Cancelled Subscription

Placed Recurring Subscription Order

Useful additional events

Logged In

Searched

Signed Up