Nitro Event and Contact Payload Reference

Review the structure of the contacts and events that NitroX exports to Netcore CE.

Overview

NitroX exports user profiles and user behaviour events to Netcore CE. Netcore CE uses them for behavioural segmentation, journey automation, and analytics. All payloads use JSON. Each payload includes contact identifiers and user profile details.

Data	API	Authentication
Contacts	`apiv2` with `type=contact` and `activity=addsync`	API key in the request URL
Events	`v1/activity/upload`	Bearer token in the `authorization` header

📘
Note
NitroX sends these requests for you after you set up the integration. This page helps you understand the data. You do not need to call these APIs yourself.

How the Primary Identifier Affects the Data

The primary identifier you select in NitroX decides the value of identity in each event.

Primary identifier	Value of `identity`
Phone Number	The phone number with the country code.
Email	The email address.
Anon ID	The Nitro ID, sent as the anonymous ID.

In the samples below, identity shows a phone number.

Contacts

Contact payload

NitroX sends this payload when it identifies a customer.

{
  "NAME": "Manya Gupta",
  "EMAIL": "[email protected]",
  "MOBILE": 9910034160,
  "NITRO_ID": "89fdcd76-4717-4a79-ba35-f4b2b213971d"
}

Attribute	Type	Description
`NAME`	String	Name of the customer.
`EMAIL`	String	Email address of the customer.
`MOBILE`	Number	Mobile number of the customer.
`NITRO_ID`	String	The unique Nitro identifier of the customer.

Sample request

curl --location \
  'https://apiin.netcoresmartech.com/apiv2?type=contact&activity=addsync&apikey=YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'data={
    "NAME": "John Doe",
    "EMAIL": "[email protected]",
    "MOBILE": 9876543210,
    "NITRO_ID": "89fdcd76-4717-4a79-ba35-f4b2b213971d"
  }'

Sample response

Netcore CE returns this response when it adds the contact.

{
  "status": "success",
  "details": "Data Added successfully",
  "id": 57226
}

Events

Common event structure

Every event uses the same outer structure. The activity_params object changes for each event.

Field	Type	Description
`asset_id`	String	The Asset ID of your Netcore CE website.
`activity_name`	String	The event name, with the `nitro_` prefix.
`email`	String	Email address of the customer.
`mobile`	String	Mobile number of the customer, with the country code.
`timestamp`	String	Time of the event in ISO 8601 format, in UTC.
`identity`	String	The identifier of the customer. It depends on your primary identifier.
`activity_source`	String	The source of the event. For Nitro events, the value is `web`.
`activity_params`	Object	The details of the event.

Each event also carries a customer object inside activity_params.

Field	Description
`customer.email`	Email address of the customer.
`customer.phone`	Phone number of the customer, with the country code.
`customer.name`	Name of the customer.

Event list

#	Event	Activity name
1	View	`nitro_view`
2	Category view	`nitro_category_view`
3	Product view	`nitro_product_view`
4	Add to cart	`nitro_addtocart`
5	Remove from cart	`nitro_removefromcart`
6	Checkout	`nitro_checkout`
7	Order created	`nitro_orders/create`
8	Order fulfilled	`nitro_orders/fulfilled`
9	Order paid	`nitro_orders/paid`
10	Order updated	`nitro_orders/updated`
11	Consent given	`nitro_is_consented`
12	OTP verified	`nitro_otp_verified`

1. View

Tracks when a user visits a general page on your site. This excludes product and collection pages.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_view",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T11:05:01.840374+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "page": "https://store.myshopify.com/?utm_source=Nitro",
      "h": "store.myshopify.com",
      "l": "https://store.myshopify.com/?utm_source=Nitro",
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`page`	URL of the page that the user visited.
`h`	Host name of the store.
`l`	Full URL of the page.

2. Category view

Logs when a user views a collection or category page.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_category_view",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T11:06:03.424815+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "page": "https://store.myshopify.com/collections/all",
      "resource_id": 453889491202,
      "resource": "collection",
      "domain": "store.myshopify.com",
      "h": "store.myshopify.com",
      "l": "https://store.myshopify.com/collections/all",
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`page`	URL of the collection page.
`resource_id`	ID of the collection.
`resource`	Type of resource. The value is `collection`.
`domain`	Domain of the store.
`h`	Host name of the store.
`l`	Full URL of the page.

3. Product view

Captures when a user lands on a product detail page.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_product_view",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T11:05:23.334416+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "page": "https://myshopify.com/products/the-snowboard",
      "resource_id": 8213254668437,
      "resource": "product",
      "domain": "myshopify.com",
      "price": "2199.00",
      "h": "myshopify.com",
      "l": "https://myshopify.com/products/the-snowboard",
      "title": "The Snowboard",
      "image": "https://cdn.shopify.com/s/files/7669/products/Main_8028a.jpg",
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`page`	URL of the product page.
`resource_id`	ID of the product.
`resource`	Type of resource. The value is `product`.
`domain`	Domain of the store.
`price`	Price of the product.
`title`	Name of the product.
`image`	URL of the product image.
`h`	Host name of the store.
`l`	Full URL of the page.

4. Add to cart

Fires when a user adds one or more items to the cart.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_addtocart",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T10:39:46.134459+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "cart_value": 1998.0,
      "recent_product_image": "https://cdn.shopify.com/s/files/products/8a.jpg",
      "init_cart": false,
      "empty_cart": false,
      "items_added": [
        {
          "quantity": 1,
          "title": "The Snowboard",
          "line_price": "999.00",
          "id": 48215129718996,
          "product_id": 9248876560596,
          "product_url": "https://myshopify.com/products/the-snowboard",
          "image_url": "https://cdn.shopify.com/s/products/Main_8028a.jpg"
        }
      ],
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`cart_value`	Total value of the cart.
`recent_product_image`	Image of the most recent product in the cart.
`init_cart`	Indicates whether this event started a new cart.
`empty_cart`	Indicates whether the cart is empty.
`items_added`	The list of items that the user added.
`items_added[].quantity`	Quantity of the item.
`items_added[].title`	Name of the item.
`items_added[].line_price`	Price of the line item.
`items_added[].id`	ID of the line item.
`items_added[].product_id`	ID of the product.
`items_added[].product_url`	URL of the product page.
`items_added[].image_url`	URL of the product image.

5. Remove from cart

Records when a user removes an item or empties the cart.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_removefromcart",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T10:51:56.329890+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "line_items": [
        {
          "quantity": 1,
          "title": "The Snowboard",
          "line_price": "499.00",
          "id": 45807276654804,
          "product_id": 8676272963796,
          "product_url": "https://myshopify.com/products/the-snowboard",
          "image_url": "https://cdn.shopify.com/s/products/Main_801a.jpg"
        }
      ],
      "cart_value": 499.00,
      "recent_product_image": "https://cdn.shopify.com/s/products/Main_809a.jpg",
      "init_cart": false,
      "empty_cart": false,
      "items_added": [],
      "items_removed": [
        {
          "quantity": 1,
          "title": "The Jacket",
          "line_price": "999.00",
          "id": 48215129718996,
          "product_id": 9248876560596,
          "product_url": "https://myshopify.com/products/the-jacket",
          "image_url": "https://cdn.shopify.com/s/products/Main_802a.jpg"
        }
      ],
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`line_items`	The items that remain in the cart.
`cart_value`	Total value of the cart after the removal.
`recent_product_image`	Image of the most recent product in the cart.
`init_cart`	Indicates whether this event started a new cart.
`empty_cart`	Indicates whether the cart is empty.
`items_added`	The list of items added in this action. It is empty for a removal.
`items_removed`	The list of items that the user removed.

Each item in line_items and items_removed has the same fields as an item in the Add to cart event.

6. Checkout

Triggers when a user proceeds to the checkout page.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_checkout",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T03:35:37.924903+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "checkout": "https://store.myshopify.com/checkout",
      "cart_value": "1078.00",
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`checkout`	URL of the checkout page.
`cart_value`	Total value of the cart.

7. Order created

Captures a new order when the user places it successfully.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_orders/create",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T10:31:22.950028+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "url": "https://store.myshopify.com/919876543210/orders/dabb6f8ae",
      "order_id": 7061190901944,
      "order_number": 288574,
      "order_name": "LG5RFIYVQ",
      "price": "9186.55",
      "currency": "INR",
      "order_created_at": "2026-10-03T09:37:34+05:30",
      "coupon_codes": ["SALE5"],
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`url`	URL of the order.
`order_id`	ID of the order.
`order_number`	Number of the order.
`order_name`	Name of the order.
`price`	Total price of the order.
`currency`	Currency of the order.
`order_created_at`	Time when the order was created.
`coupon_codes`	The coupon codes that the user applied.

The order events 7 to 10 share these parameters.

8. Order fulfilled

Indicates that an order has been fulfilled.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_orders/fulfilled",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-09-30T11:56:39.915148+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "url": "https://store.myshopify.com/919876543210/orders/dabb6f8ae",
      "order_id": 7056900882616,
      "order_number": 288473,
      "order_name": "V8D7CC92X",
      "price": "9948.00",
      "currency": "INR",
      "order_created_at": "2026-10-01T16:21:57+05:30",
      "coupon_codes": ["NITRO"],
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

9. Order paid

Indicates that an order has been paid.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_orders/paid",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-09-30T13:48:51.821041+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "url": "https://store.myshopify.com/919876543210/orders/dabb6f8ae",
      "order_id": 7059103940792,
      "order_number": 288530,
      "order_name": "TUN6GY5R8",
      "price": "17315.10",
      "currency": "INR",
      "order_created_at": "2026-10-02T13:20:08+05:30",
      "coupon_codes": ["NITRO"],
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

10. Order updated

Logs when the status or details of an existing order change after purchase.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_orders/updated",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-03T11:03:56.762176+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "url": "https://store.myshopify.com/919876543210/orders/dabb6f8ae",
      "order_id": 7061190901944,
      "order_number": 288574,
      "order_name": "LG5RFIYVQ",
      "price": "9186.55",
      "currency": "INR",
      "order_created_at": "2026-10-03T09:37:34+05:30",
      "coupon_codes": ["NITRO"],
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

11. Consent given

Marks when a user gives explicit consent through the Nitro pop-up or consent layer.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_is_consented",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-01T10:48:48.279240+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "phone": "9876543210",
      "is_consented": true,
      "source": "popup",
      "h": "store.myshopify.com",
      "l": "https://store.myshopify.com/?utm_source=Nitro",
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`phone`	Phone number of the user, without the country code.
`is_consented`	Indicates whether the user gave consent.
`source`	Where the user gave consent. For example, `popup`.
`h`	Host name of the store.
`l`	Full URL of the page.

12. OTP verified

Confirms that the user verified the OTP during a consent or login flow.

[
  {
    "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
    "activity_name": "nitro_otp_verified",
    "email": "[email protected]",
    "mobile": "919876543210",
    "timestamp": "2026-10-01T10:48:54.732428+00:00",
    "identity": "919876543210",
    "activity_source": "web",
    "activity_params": {
      "phone": "9876543210",
      "h": "store.myshopify.com",
      "l": "https://store.myshopify.com/?utm_source=Nitro",
      "customer": {
        "email": "[email protected]",
        "phone": "+919876543210",
        "name": "John Doe"
      }
    }
  }
]

Parameter	Description
`phone`	Phone number of the user, without the country code.
`h`	Host name of the store.
`l`	Full URL of the page.

Sample event request

curl 'https://api2.netcoresmartech.com/v1/activity/upload' \
  -X POST \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'content-type: application/json' \
  --data '[
    {
      "asset_id": "893d325789d7014a3631XXXXXXXXX3d",
      "activity_name": "nitro_view",
      "email": "[email protected]",
      "mobile": "919876543210",
      "timestamp": "2026-10-03T11:06:47.254299+00:00",
      "identity": "919876543210",
      "activity_source": "web",
      "activity_params": {
        "page": "https://store.myshopify.com/?utm_source=Nitro",
        "h": "store.myshopify.com",
        "l": "https://store.myshopify.com/?utm_source=Nitro",
        "customer": {
          "email": "[email protected]",
          "phone": "+919876543210",
          "name": "John Doe"
        }
      }
    }
  ]'

Sample event response

Netcore CE returns this response when it receives and processes the event.

{
  "status": "success"
}

Updated 2 days ago

Did this page help you?