Kindly ensure to update your products and historical customer data (if any) before sending events to use automations, segments, and campaigns on the Contlo dashboard.

Now that you have created your account, synced your products, and connected your website with Contlo, all you need to do is to start sending across your users' events.


Analyzing events is very important for understanding how users interact with a website. The events play an important role in decision-making.

Types of Events

There are three types of events handled by Contlo for custom businesses:

Message Events

These events are related to push notifications and are automatically captured when a user interacts with the notification after you have integrated our custom snippet with your website.

Custom Events

These events are your user journey events that you would track across the user journey.

You can send events with custom property, using Contlo's Track API v1. Some examples of custom store events -

Use our Track API v1 for sending the following example events-

Viewed ProductWhen someone views a product
Added to CartWhen someone adds an item to their cart
Started CheckoutWhen someone lands on the checkout page
Placed OrderWhen an order successfully processes on your system
Fulfilled OrderWhen an order is processed
Cancelled OrderWhen an order is cancelled
Refunded OrderWhen a customer’s order is refunded
Order in TransitWhen an order is in transit
Order DeliveredWhen an order is delivered to the customer.

Over here - Track API v1, you'll find a generic example for how to use the Track API v1. This example does not point out to the usage of a specific event but instead, generally points out to what the Track API v1 for an event could look like.

Charged Events

You should record transactions or purchases in Contlo using a special event called Charged.

What makes Charged a special event?

  • Charged is a special event because it provides a way for you to specify the items sold, their categories, transaction amount, the transaction id, and the information about your users.
  • Recording a purchase against a user marks them as a customer in Contlo. This enables you to compare your funnel reports between customers and non-customers.
  • Recording the Transaction Amount
    The transaction total or charge should be recorded in an event property called Transaction value.

Mandatory Properties to record a Charged event

event_idstringUsed to map the event.
transacation_valuestringThe value attributed to the revenue.
variant_idstringThe corresponding variant(s) ID for which transaction is taking place.
event_typestringType of event (Charged)
currencystringCurrency code of variant prices. Follow ISO 4217:2015 Format: https://en.wikipedia.org/wiki/ISO_4217
transaction_idstringUnique identifier of the transaction.
emailstringEmail ID of the customer
phone numberstringPhone number of the customer.
product_idstringThe corresponding product (s) ID for which the transaction is taking place.
timeLongEpoch time in milli seconds.

Example JSON:

   "email":"[email protected]",
      "product_ids": ["prod1", "prod2", "prod3"],
      "collection_ids": ["col1", "col2", "col3"],
      "variant_ids": ["var1", "var2", "var3", "var4"]

Advantages of the Charged Event

  • Helps you identify your customers, and how are they using your app or website
  • Run campaigns to reward loyal users or get lost customers back
  • Measure customer loyalty via running a cohort analysis on repeat purchases
  • Analyze paid campaign performance by total revenue earned
  • Get revenue insights like – total revenue, number of transactions, count of paying users and much more.

You can use all the above events created through the Track API v1 in your Automations.

Verify Integration:

After setting up, to verify your integration you can send a sample event to Contlo. Once the event is sent, go to Audience section on the Contlo platform.

If you are able to see a user profile created with the sample event, then this means that you have successfully completed the integration.

Welcome aboard!!