4	API-integration	3180d0bf65fa99d80a503269aa30eff9590de9fa	API Integration Orbis<>Nitro		f	t	\N			# API Interation Orbis<>Nitro\n\nAPIs to pass events from Nitro to Orbis.\n**Orbis Production Host:** https://app.orbisdata.ai\n\n## Learn API - Submit Event\nEndpoint to submit a learning event for tracking.\n\n### Endpoint\n```\nPOST {{host}}/rest/v1/learn/event\n```\n\n### Request Body\n**JSON Parameters**\n- **org_token** (string, required): Your organization's unique token.\n- **eventName** (string, required): Name of the event being tracked.\n- **eventVal** (string or JSON, required): Value associated with the event. Can be a simple string or a JSON object.\n- **eventCategory** (string, optional, default: "EXTERNAL"): Category of the event. Use "EXTERNAL" for events originating outside the system.\n- **u** (string, optional): Canonical URL related to the event.\n- **lang** (string, optional, default: "en"): Language of the event data.\n\n**Example Request**\n\n```json\n{\n  "org_token": "{{your_org_token}}",\n  "eventName": "{{eventname}}",\n  "eventVal": {\n    "key1": "value1",\n    "key2": "value2"\n  },\n  "eventCategory": "EXTERNAL",\n  "u": "{{canonicalUrl}}",\n  "lang": "en"\n}\n\n}\n```\n\n### Notes\n- The eventValue field can either be a simple string or a JSON object, providing flexibility in the type of data associated with the event.\n- The eventCategory field is optional and defaults to "EXTERNAL" if not specified.\n- The u field is optional and can be used to provide a canonical URL related to the event. This should be a valid URL.\n- The lang field is optional and defaults to "en" if not specified.\n\n\n### Response\n- If the submission is successful, the API will respond with the following success message:\n```json\nResponse: 200 OK \n{\n "status": "success"\n}\n}\n```\n\n- If the organization is not found, the API will respond with the following error:\n```json\nResponse: 400 BAD REQUEST\n{\n "status": "failed",\n "code": 5104,\n "reason": "Please provide the correct token in the URL."\n}\n```\nThe API will respond with the appropriate status code and a JSON object containing any relevant information or error messages.\n\n\n## User and Organization Registration API\nEndpoint to register a new user and Organization.\n\n### Endpoint\n```\nPOST {{host}}/api/v1/register?token=182416ce389f64a5ffc090dd14bc8da40b4ced86\n```\n\n### Request Body\n**JSON Parameters**\n- **email** (string, required): User's email address.\n- **password** (string, required): User's chosen password.\n- **first_name** (string, required): User's first name.\n- **domain** (string, required): User's domain.\n- **entity** (string, required): User's entity information.\n\n#### Example Request\n```json\n{\n "email": "a3@b.com",\n "password": "1234",\n "first_name": "AT",\n "domain": "domain3.com",\n "entity": "x.getnitro.co"\n}\n```\n\n#### Responses\n**Error Responses**\n- If the user already exists, the API will respond with a 400 BAD REQUEST and the following error message:\n```\nResponse: 400 BAD REQUEST\n\n{\n "status": "error",\n "message": "a3@b.com already registered! Please sign in to continue."\n}\n```\n\n- If the organization already exists, the API will respond with a 400 BAD REQUEST and the following error message:\n```\nResponse: 400 BAD REQUEST\n{\n "status": "error",\n "message": "Org already exists"\n}\n```\n\n**Success Response**\n- If the registration is successful, the API will respond with the following success message:\n```\nResponse: 200 OK \n{\n "status": "success",\n "message": "Registration successful"\n}\n```\nThe API will respond with the appropriate status code and a JSON object containing relevant information or error messages.\n\n	<h1 class="toc-header" id="api-interation-orbisnitro"><a href="#api-interation-orbisnitro" class="toc-anchor">¶</a> API Interation Orbis&lt;&gt;Nitro</h1>\n<p>APIs to pass events from Nitro to Orbis.<br>\n<strong>Orbis Production Host:</strong> <a class="is-external-link" href="https://app.orbisdata.ai">https://app.orbisdata.ai</a></p>\n<h2 class="toc-header" id="learn-api-submit-event"><a href="#learn-api-submit-event" class="toc-anchor">¶</a> Learn API - Submit Event</h2>\n<p>Endpoint to submit a learning event for tracking.</p>\n<h3 class="toc-header" id="endpoint"><a href="#endpoint" class="toc-anchor">¶</a> Endpoint</h3>\n<pre v-pre="true" class="prismjs line-numbers"><code v-pre="true" class="language-">POST {{host}}/rest/v1/learn/event\n</code></pre>\n<h3 class="toc-header" id="request-body"><a href="#request-body" class="toc-anchor">¶</a> Request Body</h3>\n<p><strong>JSON Parameters</strong></p>\n<ul>\n<li><strong>org_token</strong> (string, required): Your organization's unique token.</li>\n<li><strong>eventName</strong> (string, required): Name of the event being tracked.</li>\n<li><strong>eventVal</strong> (string or JSON, required): Value associated with the event. Can be a simple string or a JSON object.</li>\n<li><strong>eventCategory</strong> (string, optional, default: "EXTERNAL"): Category of the event. Use "EXTERNAL" for events originating outside the system.</li>\n<li><strong>u</strong> (string, optional): Canonical URL related to the event.</li>\n<li><strong>lang</strong> (string, optional, default: "en"): Language of the event data.</li>\n</ul>\n<p><strong>Example Request</strong></p>\n<pre v-pre="true" class="prismjs line-numbers"><code v-pre="true" class="language-json">{\n  "org_token": "{{your_org_token}}",\n  "eventName": "{{eventname}}",\n  "eventVal": {\n    "key1": "value1",\n    "key2": "value2"\n  },\n  "eventCategory": "EXTERNAL",\n  "u": "{{canonicalUrl}}",\n  "lang": "en"\n}\n\n}\n</code></pre>\n<h3 class="toc-header" id="notes"><a href="#notes" class="toc-anchor">¶</a> Notes</h3>\n<ul>\n<li>The eventValue field can either be a simple string or a JSON object, providing flexibility in the type of data associated with the event.</li>\n<li>The eventCategory field is optional and defaults to "EXTERNAL" if not specified.</li>\n<li>The u field is optional and can be used to provide a canonical URL related to the event. This should be a valid URL.</li>\n<li>The lang field is optional and defaults to "en" if not specified.</li>\n</ul>\n<h3 class="toc-header" id="response"><a href="#response" class="toc-anchor">¶</a> Response</h3>\n<ul>\n<li>If the submission is successful, the API will respond with the following success message:</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">Response: 200 OK \n{\n "status": "success"\n}\n}\n</code></pre>\n<ul>\n<li>If the organization is not found, the API will respond with the following error:</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">Response: 400 BAD REQUEST\n{\n "status": "failed",\n "code": 5104,\n "reason": "Please provide the correct token in the URL."\n}\n</code></pre>\n<p>The API will respond with the appropriate status code and a JSON object containing any relevant information or error messages.</p>\n<h2 class="toc-header" id="user-and-organization-registration-api"><a href="#user-and-organization-registration-api" class="toc-anchor">¶</a> User and Organization Registration API</h2>\n<p>Endpoint to register a new user and Organization.</p>\n<h3 class="toc-header" id="endpoint-1"><a href="#endpoint-1" class="toc-anchor">¶</a> Endpoint</h3>\n<pre v-pre="true" class="prismjs line-numbers"><code v-pre="true" class="language-">POST {{host}}/api/v1/register?token=182416ce389f64a5ffc090dd14bc8da40b4ced86\n</code></pre>\n<h3 class="toc-header" id="request-body-1"><a href="#request-body-1" class="toc-anchor">¶</a> Request Body</h3>\n<p><strong>JSON Parameters</strong></p>\n<ul>\n<li><strong>email</strong> (string, required): User's email address.</li>\n<li><strong>password</strong> (string, required): User's chosen password.</li>\n<li><strong>first_name</strong> (string, required): User's first name.</li>\n<li><strong>domain</strong> (string, required): User's domain.</li>\n<li><strong>entity</strong> (string, required): User's entity information.</li>\n</ul>\n<h4 class="toc-header" id="example-request"><a href="#example-request" class="toc-anchor">¶</a> Example Request</h4>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">{\n "email": "a3@b.com",\n "password": "1234",\n "first_name": "AT",\n "domain": "domain3.com",\n "entity": "x.getnitro.co"\n}\n</code></pre>\n<h4 class="toc-header" id="responses"><a href="#responses" class="toc-anchor">¶</a> Responses</h4>\n<p><strong>Error Responses</strong></p>\n<ul>\n<li>If the user already exists, the API will respond with a 400 BAD REQUEST and the following error message:</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Response: 400 BAD REQUEST\n\n{\n "status": "error",\n "message": "a3@b.com already registered! Please sign in to continue."\n}\n</code></pre>\n<ul>\n<li>If the organization already exists, the API will respond with a 400 BAD REQUEST and the following error message:</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Response: 400 BAD REQUEST\n{\n "status": "error",\n "message": "Org already exists"\n}\n</code></pre>\n<p><strong>Success Response</strong></p>\n<ul>\n<li>If the registration is successful, the API will respond with the following success message:</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Response: 200 OK \n{\n "status": "success",\n "message": "Registration successful"\n}\n</code></pre>\n<p>The API will respond with the appropriate status code and a JSON object containing relevant information or error messages.</p>\n	[{"title":"API Interation Orbis<>Nitro","anchor":"#api-interation-orbisnitro","children":[{"title":"Learn API - Submit Event","anchor":"#learn-api-submit-event","children":[{"title":"Endpoint","anchor":"#endpoint","children":[]},{"title":"Request Body","anchor":"#request-body","children":[]},{"title":"Notes","anchor":"#notes","children":[]},{"title":"Response","anchor":"#response","children":[]}]},{"title":"User and Organization Registration API","anchor":"#user-and-organization-registration-api","children":[{"title":"Endpoint","anchor":"#endpoint-1","children":[]},{"title":"Request Body","anchor":"#request-body-1","children":[{"title":"Example Request","anchor":"#example-request","children":[]},{"title":"Responses","anchor":"#responses","children":[]}]}]}]}]	markdown	2024-01-25T11:37:12.145Z	2024-01-30T11:14:01.733Z	markdown	en	3	3	{"js":"","css":""}
5	Webhook-Export	4af597301e8d7b1eafd1ba102ac8dd40ec5e5bb8	Exporting via Webhooks		f	t	\N			Goto: Integrations Tab\n\n### Step 1\n\nRegister a webhook, and specify the URL and timeout that Nitro server should wait before giving up on the request (in seconds).\nYou can optionally specify a basic autorization that will be passed along in the headers.\n\n![image_(2).png](/screenshots/image_(2).png)\n\n\n## Export on Matched Contact\nYour webhooks will start to recieve the following POST requests for at the time of every matched contact.\n\n```SHELL\nPOST https://webhook-address.com/endpoint\nContent-Type: application/json\nAuthorization: Bearer <specified-token>\nUser-Agent: Mozilla/5.0 (compatible; NitroCommerce/2.1; +https://nitrocommerce.ai)\n\n{\n   "medium": "matched",\n   "contact": "+918505850022"\n   "type": "PHONE/EMAIL",\n   "date": "2024-02-12",\n   "org_id": "your-org-id",\n   \n   "last_addtocart": "<product_url>",\n   "last_view": ["<product_url_1>", "<product_url_1>", "<product_url_1>"]\n}\n```\n\nWhere:\n```yaml\ncontact: email or phone of the contact detected.\ntype: string from one of {PHONE,EMAIL}\ndate: yyyy-mm-dd formatted date\norg_id: your organisation ID at Nitro.\n```\n(The above 4 fields are always sent)\n\nAlong with these, the following fileds will be sent, depending on what data Nitro has (depending on deep integration).\n\n```yaml\nlast_addtocart: Product URL of the last product that user has added to cart.\nlast_view: Product URLs of last 3 viewed products by the user.\n```\n\n\n## Export trigger on Event\n\nAnother trigger that you can use to capture data is via export on event stream. This data will be sent to specifed endpoint when any activity happens by the user at your webapp.\n\n```SHELL\nPOST https://webhook-address.com/endpoint\nContent-Type: application/json\nAuthorization: Bearer <specified-token>\nUser-Agent: Mozilla/5.0 (compatible; NitroCommerce/2.1; +https://nitrocommerce.ai)\n\n{\n   "medium": "event",\n   "contact": "+918505850022"\n   "type": "PHONE/EMAIL",\n   "date": "2024-02-12",\n   "org_id": "your-org-id",\n   \n   "event": "addtocart/view/buy"\n}\n```\n	<p>Goto: Integrations Tab</p>\n<h3 class="toc-header" id="step-1"><a href="#step-1" class="toc-anchor">¶</a> Step 1</h3>\n<p>Register a webhook, and specify the URL and timeout that Nitro server should wait before giving up on the request (in seconds).<br>\nYou can optionally specify a basic autorization that will be passed along in the headers.</p>\n<p><img alt="image_(2).png" src="/screenshots/image_(2).png"></p>\n<h2 class="toc-header" id="export-on-matched-contact"><a href="#export-on-matched-contact" class="toc-anchor">¶</a> Export on Matched Contact</h2>\n<p>Your webhooks will start to recieve the following POST requests for at the time of every matched contact.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-SHELL">POST https://webhook-address.com/endpoint\nContent-Type: application/json\nAuthorization: Bearer &lt;specified-token&gt;\nUser-Agent: Mozilla/5.0 (compatible; NitroCommerce/2.1; +https://nitrocommerce.ai)\n\n{\n   "medium": "matched",\n   "contact": "+918505850022"\n   "type": "PHONE/EMAIL",\n   "date": "2024-02-12",\n   "org_id": "your-org-id",\n   \n   "last_addtocart": "&lt;product_url&gt;",\n   "last_view": ["&lt;product_url_1&gt;", "&lt;product_url_1&gt;", "&lt;product_url_1&gt;"]\n}\n</code></pre>\n<p>Where:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-yaml">contact: email or phone of the contact detected.\ntype: string from one of {PHONE,EMAIL}\ndate: yyyy-mm-dd formatted date\norg_id: your organisation ID at Nitro.\n</code></pre>\n<p>(The above 4 fields are always sent)</p>\n<p>Along with these, the following fileds will be sent, depending on what data Nitro has (depending on deep integration).</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-yaml">last_addtocart: Product URL of the last product that user has added to cart.\nlast_view: Product URLs of last 3 viewed products by the user.\n</code></pre>\n<h2 class="toc-header" id="export-trigger-on-event"><a href="#export-trigger-on-event" class="toc-anchor">¶</a> Export trigger on Event</h2>\n<p>Another trigger that you can use to capture data is via export on event stream. This data will be sent to specifed endpoint when any activity happens by the user at your webapp.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-SHELL">POST https://webhook-address.com/endpoint\nContent-Type: application/json\nAuthorization: Bearer &lt;specified-token&gt;\nUser-Agent: Mozilla/5.0 (compatible; NitroCommerce/2.1; +https://nitrocommerce.ai)\n\n{\n   "medium": "event",\n   "contact": "+918505850022"\n   "type": "PHONE/EMAIL",\n   "date": "2024-02-12",\n   "org_id": "your-org-id",\n   \n   "event": "addtocart/view/buy"\n}\n</code></pre>\n	[{"title":"Export on Matched Contact","anchor":"#export-on-matched-contact","children":[]},{"title":"Export trigger on Event","anchor":"#export-trigger-on-event","children":[]}]	markdown	2024-02-16T12:57:27.911Z	2024-02-19T12:01:21.313Z	markdown	en	1	1	{"js":"","css":""}
6	exporting-data	9c472154cff0b77415f64439f7902fdf5a05b8ec	Exporting Data		f	t	\N			There as multiple integrations available to export data.\n\n* [Webhook-Export](/Webhook-Export)\n* [Javascript-Export-hooks](/javascript-events)	<p>There as multiple integrations available to export data.</p>\n<ul>\n<li><a class="is-internal-link is-valid-page" href="/Webhook-Export">Webhook-Export</a></li>\n<li><a class="is-internal-link is-invalid-page" href="/javascript-events">Javascript-Export-hooks</a></li>\n</ul>\n	[]	markdown	2024-02-16T13:01:20.127Z	2024-05-31T08:26:16.175Z	markdown	en	1	1	{"js":"","css":""}
13	wordpress-plugin	0071b22519fd44ff986a0cb311c335134fd158fd	Nitro Wordpress Plugin		f	t	\N			# Nitrox WordPress Plugin Installation Guide\n\n## Table of Contents\n1. [Introduction](#introduction)\n2. [Requirements](#requirements)\n3. [Installation](#installation)\n4. [Configuration](#configuration)\n5. [Usage](#usage)\n6. [Event Tracking](#event-tracking)\n7. [Custom Event Tracking](#custom-event-tracking)\n\n## Introduction\nThe Nitrox WordPress plugin is designed to track user activities on your WooCommerce store and send these events to the Nitrox SaaS application. The plugin captures events like product views, add to cart, checkout, purchase, and more, providing valuable insights into user behavior.\n\n## Requirements\n- WordPress 5.0 or higher\n- WooCommerce 3.0 or higher\n- PHP 7.0 or higher\n- Nitrox SaaS account\n\n## Installation\n### Manual Installation\n1. **Download the Plugin**\n   - Download the latest version of the Nitrox plugin from the [Nitrox](https://cdn.nitrocommerce.ai/plugins/nitrox-woocommerce.zip).\n\n2. **Upload the Plugin to WordPress**\n   - Go to your WordPress admin dashboard.\n   - Navigate to `Plugins` > `Add New`.\n   - Click on the `Upload Plugin` button.\n   - Choose the downloaded plugin file (`nitrox.zip`) and click `Install Now`.\n\n3. **Activate the Plugin**\n   - After the installation, click on `Activate Plugin` to enable Nitrox.\n\n### Installation via FTP\n1. **Download the Plugin**\n   - Download the latest version of the Nitrox plugin from the [Nitrox](https://cdn.nitrocommerce.ai/plugins/nitrox-woocommerce.zip).\n\n2. **Upload the Plugin via FTP**\n   - Unzip the `nitrox.zip` file.\n   - Connect to your server via FTP.\n   - Navigate to the `/wp-content/plugins/` directory.\n   - Upload the unzipped `nitrox` folder to this directory.\n\n3. **Activate the Plugin**\n   - Go to your WordPress admin dashboard.\n   - Navigate to `Plugins` and find `Nitrox` in the list.\n   - Click `Activate` to enable the plugin.\n\n## Configuration\n1. **Access the Settings**\n   - Go to `Settings` > `Nitrox` in your WordPress admin dashboard.\n\n2. **Enter the Org Token**\n   - Enter your organization token provided by Nitrox in the `Org Token` field.\n\n3. **Save Changes**\n   - Click `Save Changes` to store your settings.\n\n## Usage\n### Event Tracking\nThe Nitrox plugin automatically tracks the following events on your WooCommerce store:\n- **Product View:** When a user views a product page.\n- **Update Cart:** When a user adds a product to their cart..\n- **Checkout:** When a user initiates the checkout process.\n- **Buy:** When a user completes a purchase.\n- **Category View:** When a user views a product category page.\n- **Removed From Cart:** When a user removes a product from their cart.\n- **User Registration:** When a user registers on your site.\n- **User Login:** When a user logs in to your site.\n\n\n### Custom Event Tracking\nYou can also track custom events using the global JavaScript methods provided by the plugin. These methods can be called from anywhere within your site to track specific user interactions.\n\n#### Example:\n```javascript\n<script>\n  // Track a custom event\n  nitro.track('custom_event_name', {\n    property1: 'value1',\n    property2: 'value2'\n  });\n</script>\n	<h1 class="toc-header" id="nitrox-wordpress-plugin-installation-guide"><a href="#nitrox-wordpress-plugin-installation-guide" class="toc-anchor">¶</a> Nitrox WordPress Plugin Installation Guide</h1>\n<h2 class="toc-header" id="table-of-contents"><a href="#table-of-contents" class="toc-anchor">¶</a> Table of Contents</h2>\n<ol>\n<li><a href="#introduction">Introduction</a></li>\n<li><a href="#requirements">Requirements</a></li>\n<li><a href="#installation">Installation</a></li>\n<li><a href="#configuration">Configuration</a></li>\n<li><a href="#usage">Usage</a></li>\n<li><a href="#event-tracking">Event Tracking</a></li>\n<li><a href="#custom-event-tracking">Custom Event Tracking</a></li>\n</ol>\n<h2 class="toc-header" id="introduction"><a href="#introduction" class="toc-anchor">¶</a> Introduction</h2>\n<p>The Nitrox WordPress plugin is designed to track user activities on your WooCommerce store and send these events to the Nitrox SaaS application. The plugin captures events like product views, add to cart, checkout, purchase, and more, providing valuable insights into user behavior.</p>\n<h2 class="toc-header" id="requirements"><a href="#requirements" class="toc-anchor">¶</a> Requirements</h2>\n<ul>\n<li>WordPress 5.0 or higher</li>\n<li>WooCommerce 3.0 or higher</li>\n<li>PHP 7.0 or higher</li>\n<li>Nitrox SaaS account</li>\n</ul>\n<h2 class="toc-header" id="installation"><a href="#installation" class="toc-anchor">¶</a> Installation</h2>\n<h3 class="toc-header" id="manual-installation"><a href="#manual-installation" class="toc-anchor">¶</a> Manual Installation</h3>\n<ol>\n<li>\n<p><strong>Download the Plugin</strong></p>\n<ul>\n<li>Download the latest version of the Nitrox plugin from the <a class="is-external-link" href="https://cdn.nitrocommerce.ai/plugins/nitrox-woocommerce.zip">Nitrox</a>.</li>\n</ul>\n</li>\n<li>\n<p><strong>Upload the Plugin to WordPress</strong></p>\n<ul>\n<li>Go to your WordPress admin dashboard.</li>\n<li>Navigate to <code>Plugins</code> &gt; <code>Add New</code>.</li>\n<li>Click on the <code>Upload Plugin</code> button.</li>\n<li>Choose the downloaded plugin file (<code>nitrox.zip</code>) and click <code>Install Now</code>.</li>\n</ul>\n</li>\n<li>\n<p><strong>Activate the Plugin</strong></p>\n<ul>\n<li>After the installation, click on <code>Activate Plugin</code> to enable Nitrox.</li>\n</ul>\n</li>\n</ol>\n<h3 class="toc-header" id="installation-via-ftp"><a href="#installation-via-ftp" class="toc-anchor">¶</a> Installation via FTP</h3>\n<ol>\n<li>\n<p><strong>Download the Plugin</strong></p>\n<ul>\n<li>Download the latest version of the Nitrox plugin from the <a class="is-external-link" href="https://cdn.nitrocommerce.ai/plugins/nitrox-woocommerce.zip">Nitrox</a>.</li>\n</ul>\n</li>\n<li>\n<p><strong>Upload the Plugin via FTP</strong></p>\n<ul>\n<li>Unzip the <code>nitrox.zip</code> file.</li>\n<li>Connect to your server via FTP.</li>\n<li>Navigate to the <code>/wp-content/plugins/</code> directory.</li>\n<li>Upload the unzipped <code>nitrox</code> folder to this directory.</li>\n</ul>\n</li>\n<li>\n<p><strong>Activate the Plugin</strong></p>\n<ul>\n<li>Go to your WordPress admin dashboard.</li>\n<li>Navigate to <code>Plugins</code> and find <code>Nitrox</code> in the list.</li>\n<li>Click <code>Activate</code> to enable the plugin.</li>\n</ul>\n</li>\n</ol>\n<h2 class="toc-header" id="configuration"><a href="#configuration" class="toc-anchor">¶</a> Configuration</h2>\n<ol>\n<li>\n<p><strong>Access the Settings</strong></p>\n<ul>\n<li>Go to <code>Settings</code> &gt; <code>Nitrox</code> in your WordPress admin dashboard.</li>\n</ul>\n</li>\n<li>\n<p><strong>Enter the Org Token</strong></p>\n<ul>\n<li>Enter your organization token provided by Nitrox in the <code>Org Token</code> field.</li>\n</ul>\n</li>\n<li>\n<p><strong>Save Changes</strong></p>\n<ul>\n<li>Click <code>Save Changes</code> to store your settings.</li>\n</ul>\n</li>\n</ol>\n<h2 class="toc-header" id="usage"><a href="#usage" class="toc-anchor">¶</a> Usage</h2>\n<h3 class="toc-header" id="event-tracking"><a href="#event-tracking" class="toc-anchor">¶</a> Event Tracking</h3>\n<p>The Nitrox plugin automatically tracks the following events on your WooCommerce store:</p>\n<ul>\n<li><strong>Product View:</strong> When a user views a product page.</li>\n<li><strong>Update Cart:</strong> When a user adds a product to their cart..</li>\n<li><strong>Checkout:</strong> When a user initiates the checkout process.</li>\n<li><strong>Buy:</strong> When a user completes a purchase.</li>\n<li><strong>Category View:</strong> When a user views a product category page.</li>\n<li><strong>Removed From Cart:</strong> When a user removes a product from their cart.</li>\n<li><strong>User Registration:</strong> When a user registers on your site.</li>\n<li><strong>User Login:</strong> When a user logs in to your site.</li>\n</ul>\n<h3 class="toc-header" id="custom-event-tracking"><a href="#custom-event-tracking" class="toc-anchor">¶</a> Custom Event Tracking</h3>\n<p>You can also track custom events using the global JavaScript methods provided by the plugin. These methods can be called from anywhere within your site to track specific user interactions.</p>\n<h4 class="toc-header" id="example"><a href="#example" class="toc-anchor">¶</a> Example:</h4>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-javascript">&lt;script&gt;\n  // Track a custom event\n  nitro.track('custom_event_name', {\n    property1: 'value1',\n    property2: 'value2'\n  });\n&lt;/script&gt;\n</code></pre>\n	[{"title":"Nitrox WordPress Plugin Installation Guide","anchor":"#nitrox-wordpress-plugin-installation-guide","children":[{"title":"Table of Contents","anchor":"#table-of-contents","children":[]},{"title":"Introduction","anchor":"#introduction","children":[]},{"title":"Requirements","anchor":"#requirements","children":[]},{"title":"Installation","anchor":"#installation","children":[{"title":"Manual Installation","anchor":"#manual-installation","children":[]},{"title":"Installation via FTP","anchor":"#installation-via-ftp","children":[]}]},{"title":"Configuration","anchor":"#configuration","children":[]},{"title":"Usage","anchor":"#usage","children":[{"title":"Event Tracking","anchor":"#event-tracking","children":[]},{"title":"Custom Event Tracking","anchor":"#custom-event-tracking","children":[{"title":"Example:","anchor":"#example","children":[]}]}]}]}]	markdown	2024-08-06T18:39:55.635Z	2024-09-11T10:08:58.356Z	markdown	en	3	8	{"js":"","css":""}
7	SSO-APIs	c9620f8a5fc18b79f8fbaaced53bc2beb0e78fec	SSO APIs		f	t	\N			== SSO APIs\n\nRegister your app\nPath : v1/register_app?name=app_name&auth_url=https://yourappurl\n\nBegin authentication\nPath /v1/sso/begin?client_id=f38355a4-e60e-48f6-8d78-660ae2de8cbe&next=http://172.17.0.1:5173&sign=2eae9291-678a-4bc9-924f-e9075c9d6734\n\nQuery params : client_id\n\t              next\n\t\t  sign\n\nGet long lived token by short lived token\nv1/get_bearer_token?slt=3764baea-6eaa-4360-86e0-8f0d4b4baf15&client_id=f38355a4-e60e-48f6-8d78-660ae2de8cbe\n	<div class="sect1">\n<h2 class="toc-header" id="_sso_apis"><a href="#_sso_apis" class="toc-anchor">¶</a> SSO APIs</h2>\n<div class="sectionbody">\n<div class="paragraph">\n<p>Register your app\nPath : v1/register_app?name=app_name&amp;auth_url=https://yourappurl</p>\n</div>\n<div class="paragraph">\n<p>Begin authentication\nPath /v1/sso/begin?client_id=f38355a4-e60e-48f6-8d78-660ae2de8cbe&amp;next=http://172.17.0.1:5173&amp;sign=2eae9291-678a-4bc9-924f-e9075c9d6734</p>\n</div>\n<div class="paragraph">\n<p>Query params : client_id\n\t              next\n\t\t  sign</p>\n</div>\n<div class="paragraph">\n<p>Get long lived token by short lived token\nv1/get_bearer_token?slt=3764baea-6eaa-4360-86e0-8f0d4b4baf15&amp;client_id=f38355a4-e60e-48f6-8d78-660ae2de8cbe</p>\n</div>\n</div>\n</div>	[{"title":"SSO APIs","anchor":"#_sso_apis","children":[]}]	asciidoc	2024-03-20T10:16:52.105Z	2024-03-20T10:19:34.189Z	asciidoc	en	5	5	{"js":"","css":""}
10	javascript-events	c7c1c10cd5b416316138bdd1362e6743c49e046d	Capturing Data from Javascript Hook		f	t	\N			# Capturing Data from Javascript SDK\n\nWhen Nitro Identifies a user, it calls a method (if defined) as follows in the head section of your page.\n\n```\nwindow.nitroSettings = {\n   "events": {\n      "onIdentify": function (phone, email, name) {\n      }\n   }\n   // Any more settings\n}\n```\n\nNitro will call this function, whenever an identification happens.	<h1 class="toc-header" id="capturing-data-from-javascript-sdk"><a href="#capturing-data-from-javascript-sdk" class="toc-anchor">¶</a> Capturing Data from Javascript SDK</h1>\n<p>When Nitro Identifies a user, it calls a method (if defined) as follows in the head section of your page.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">window.nitroSettings = {\n   "events": {\n      "onIdentify": function (phone, email, name) {\n      }\n   }\n   // Any more settings\n}\n</code></pre>\n<p>Nitro will call this function, whenever an identification happens.</p>\n	[{"title":"Capturing Data from Javascript SDK","anchor":"#capturing-data-from-javascript-sdk","children":[]}]	markdown	2024-05-31T08:26:13.213Z	2024-05-31T08:26:15.249Z	markdown	en	1	1	{"js":"","css":""}
9	pop-up-modal	bc00d309f0c7347485aea9b1b0bdda034146b5ee	Nitro Popup Modal		f	t	\N			# Popup Modal\n\nIf you want to fire the popup manually, set the timeout of the popup to be -1 (not zero) from the UI and use this call:\n\n```\nnitro.loadPrefillCaputure()\n```\n\nThe popup can be toggled from the UI, however if you want to have events of the popup, you can set/define the following in the HEAD section of your page:\n\n```\nwindow.nitroSettings = {\n   "prefillCapture": {\n      "onClose": function () {},\n      "onShow": function () {},\n      "onFill": function (data) {\n      \t\t/* where data is seralized for that was there in the popup */\n      },\n   }\n}\n```\n\n	<h1 class="toc-header" id="popup-modal"><a href="#popup-modal" class="toc-anchor">¶</a> Popup Modal</h1>\n<p>If you want to fire the popup manually, set the timeout of the popup to be -1 (not zero) from the UI and use this call:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">nitro.loadPrefillCaputure()\n</code></pre>\n<p>The popup can be toggled from the UI, however if you want to have events of the popup, you can set/define the following in the HEAD section of your page:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">window.nitroSettings = {\n   "prefillCapture": {\n      "onClose": function () {},\n      "onShow": function () {},\n      "onFill": function (data) {\n      \t\t/* where data is seralized for that was there in the popup */\n      },\n   }\n}\n</code></pre>\n	[{"title":"Popup Modal","anchor":"#popup-modal","children":[]}]	markdown	2024-05-31T08:22:09.465Z	2024-05-31T08:24:43.294Z	markdown	en	1	1	{"js":"","css":""}
11	nitro-api	8156ad131261172c3095623e1c2bab85fce492dc	Nitro API Reference		f	t	\N			# Nitro Integration API Document\n\n\n### Scope:\nThis document covers the scope of registering a User with Nitro Commerce and getting their Organisation information, to be further used by your platform user.\n\n### Steps:\nYou need to call the login API in order to get the bearer token. This token will be used to create the User with the Nitro Commerce.\n\nCall the Register API with the required headers and data to register a Client(User) with the Nitro Commerce.\n\nWith every User, an Organisation is auto generated and assigned to that particular user. The same Organisation is also assigned to your Platform User, which can be viewed from the Dropdown provided in the top right corner of the Nitro Commerce Dashboard.\n\nYour Platform User will be able to see the list of Organisations created by them and access those Organisations.\n\n### Login API:\n```\nMethod: POST\nURL: https://svc.nitrocommerce.ai/v1/rest/<your_platform_name>/users/login\nData: { "email": "<PLATFORM_ACCOUNT_EMAIL>", "password": "<PLATFORM_ACCOUNT_PASSWORD>" }\nHeaders: \n- Content-Type: application/json\n```\n\n\n##### CURL:\n\n```curl\n\ncurl --location 'https://svc.nitrocommerce.ai/v1/rest/<your_platform_name>/users/login' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{ "email": "<PLATFORM_ACCOUNT_EMAIL>", "password": "<PLATFORM_ACCOUNT_PASSWORD>" }'\n```\n\n##### Response (200):\n\n```json\n{\n   "bearer_token": "<PLATFORM_ACCOUNT_USER_BEARER_TOKEN>",\n   "user": {\n       "id": 3,\n       "name": "<PLATFORM_ACCOUNT_USER_NAME>",\n       "email": "<PLATFORM_ACCOUNT_EMAIL>",\n       "username": "<PLATFORM_ACCOUNT_EMAIL>",\n       "is_active": true,\n       "phone": "<PLATFORM_ACCOUNT_USER_PHONE>",\n       "is_email_verified": false,\n       "is_phone_verified": false,\n       "is_superuser": false\n   },\n   "code": 2001,\n   "message": "OK"\n}\n```\n\n##### Response (401):\n```json\n{\n   "code": 4011,\n   "message": "Invalid login credentials."\n}\n```\n\n### Register User API:\n\n```\nMethod: POST\nURL: https://svc.nitrocommerce.ai/v1/rest/<your_platform_name>/users/register\nData: { "email": "<USER_EMAIL>", "name": "<NAME>", "phone": "<USER_PHONE>", "domain": "<ORGANISATION_DOMAIN>", "organisation_name": "<NAME_OF_ORGANISATION>" }\nHeaders: \n- Content-Type: application/json\n- Authorization: Bearer <platform_account_user_bearer_token>\n```\n\n##### Curl:\n```curl\ncurl --location 'https://svc.nitrocommerce.ai/v1/rest/<your_platform_name>/users/register' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: Bearer <platform_account_user_bearer_token>' \\\n--data-raw '{\n    "email": "<USER_EMAIL>", "name": "<NAME>", "phone": "<USER_PHONE>, "domain": "<ORGANISATION_DOMAIN>", "organisation_name": "<NAME_OF_ORGANISATION>""\n}'\n```\n\n##### Response (201):\n```json\n{\n   "user": {\n       "id": 3,\n       "name": "<USER_NAME>",\n       "email": "<USER_EMAIL>",\n       "username": "<USER_EMAIL>",\n       "is_active": true,\n       "phone": "<USER_PHONE>",\n       "is_email_verified": false,\n       "is_phone_verified": false,\n       "is_superuser": false\n   },\n   "organisation": {\n       "id": <ORGANISATION_ID>,\n       "token": "<ORGANISATION_TOKEN>",\n       "name": "",\n       "domain": "<ORGANISATION_DOMAIN>",\n       "currency": "",\n       "country_code": "",\n       "is_active": true,\n       "logo": "",\n       "wid": null,\n       "created_at": "2024-07-10T09:56:21.863123+00:00",\n       "modified_at": "2024-07-10T09:56:21.862801+00:00",\n       "referer": null,\n       "features_enabled": ""\n   },\n   "code": 2011,\n   "message": "Created"\n}\n```\n\n##### Response (400):\nUser:\n```json\n\n{\n   "code": 4009,\n   "message": "Email Already exists"\n}\n```\n\nOrganisation:\n```json\n{\n   "code": 40010,\n   "message": "Organisation Exists. Cannot assign existing Organisations."\n}\n```\n\n\n---\n\n\n### Webhook:\n\n##### Create:\n```\nMethod: POST\nURL: https://svc.nitrocommerce.ai/v1/rest/<your_platform_name>/integration\nData: {"org_id":<organisation_id>,"active":true,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true}}\nHeaders: \n- Content-Type: application/json\n- Authorization: Bearer <platform_account_user_bearer_token>\n```\n##### Curl:\n```curl\ncurl 'https://svc.nitrocommerce.ai/v1/rest/integration' \\\n-X 'POST' \\\n-H 'Authorization: Bearer <platform_account_user_bearer_token>' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{"org_id":<organisation_id>,"active":true,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true}}'\n```\n\n---\n\n##### Update:\n```\nMethod: PUT\nURL: https://svc.nitrocommerce.ai/v1/rest/<your_platform_name>/integration\nData: {"org_id":<organisation_id>,"active":true/false,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true},"id":<WEBHOOK_ID>}\n\nHeaders: \n- Content-Type: application/json\n- Authorization: Bearer <platform_account_user_bearer_token>\n```\n##### Curl:\n```curl\n\ncurl 'https://svc.nitrocommerce.ai/v1/rest/integration' \\\n  -X 'PUT' \\\n  -H 'Authorization: Bearer <platform_account_user_bearer_token>' \\\n  -H 'Content-Type: application/json' \\\n  --data-raw '{"org_id":<organisation_id>,"active":true/false,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true},"id":<WEBHOOK_ID>}'\n```	<h1 class="toc-header" id="nitro-integration-api-document"><a href="#nitro-integration-api-document" class="toc-anchor">¶</a> Nitro Integration API Document</h1>\n<h3 class="toc-header" id="scope"><a href="#scope" class="toc-anchor">¶</a> Scope:</h3>\n<p>This document covers the scope of registering a User with Nitro Commerce and getting their Organisation information, to be further used by your platform user.</p>\n<h3 class="toc-header" id="steps"><a href="#steps" class="toc-anchor">¶</a> Steps:</h3>\n<p>You need to call the login API in order to get the bearer token. This token will be used to create the User with the Nitro Commerce.</p>\n<p>Call the Register API with the required headers and data to register a Client(User) with the Nitro Commerce.</p>\n<p>With every User, an Organisation is auto generated and assigned to that particular user. The same Organisation is also assigned to your Platform User, which can be viewed from the Dropdown provided in the top right corner of the Nitro Commerce Dashboard.</p>\n<p>Your Platform User will be able to see the list of Organisations created by them and access those Organisations.</p>\n<h3 class="toc-header" id="login-api"><a href="#login-api" class="toc-anchor">¶</a> Login API:</h3>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Method: POST\nURL: https://svc.nitrocommerce.ai/v1/rest/&lt;your_platform_name&gt;/users/login\nData: { "email": "&lt;PLATFORM_ACCOUNT_EMAIL&gt;", "password": "&lt;PLATFORM_ACCOUNT_PASSWORD&gt;" }\nHeaders: \n- Content-Type: application/json\n</code></pre>\n<h5 class="toc-header" id="curl"><a href="#curl" class="toc-anchor">¶</a> CURL:</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-curl">\ncurl --location 'https://svc.nitrocommerce.ai/v1/rest/&lt;your_platform_name&gt;/users/login' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{ "email": "&lt;PLATFORM_ACCOUNT_EMAIL&gt;", "password": "&lt;PLATFORM_ACCOUNT_PASSWORD&gt;" }'\n</code></pre>\n<h5 class="toc-header" id="response-200"><a href="#response-200" class="toc-anchor">¶</a> Response (200):</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">{\n   "bearer_token": "&lt;PLATFORM_ACCOUNT_USER_BEARER_TOKEN&gt;",\n   "user": {\n       "id": 3,\n       "name": "&lt;PLATFORM_ACCOUNT_USER_NAME&gt;",\n       "email": "&lt;PLATFORM_ACCOUNT_EMAIL&gt;",\n       "username": "&lt;PLATFORM_ACCOUNT_EMAIL&gt;",\n       "is_active": true,\n       "phone": "&lt;PLATFORM_ACCOUNT_USER_PHONE&gt;",\n       "is_email_verified": false,\n       "is_phone_verified": false,\n       "is_superuser": false\n   },\n   "code": 2001,\n   "message": "OK"\n}\n</code></pre>\n<h5 class="toc-header" id="response-401"><a href="#response-401" class="toc-anchor">¶</a> Response (401):</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">{\n   "code": 4011,\n   "message": "Invalid login credentials."\n}\n</code></pre>\n<h3 class="toc-header" id="register-user-api"><a href="#register-user-api" class="toc-anchor">¶</a> Register User API:</h3>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Method: POST\nURL: https://svc.nitrocommerce.ai/v1/rest/&lt;your_platform_name&gt;/users/register\nData: { "email": "&lt;USER_EMAIL&gt;", "name": "&lt;NAME&gt;", "phone": "&lt;USER_PHONE&gt;", "domain": "&lt;ORGANISATION_DOMAIN&gt;", "organisation_name": "&lt;NAME_OF_ORGANISATION&gt;" }\nHeaders: \n- Content-Type: application/json\n- Authorization: Bearer &lt;platform_account_user_bearer_token&gt;\n</code></pre>\n<h5 class="toc-header" id="curl-1"><a href="#curl-1" class="toc-anchor">¶</a> Curl:</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-curl">curl --location 'https://svc.nitrocommerce.ai/v1/rest/&lt;your_platform_name&gt;/users/register' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: Bearer &lt;platform_account_user_bearer_token&gt;' \\\n--data-raw '{\n    "email": "&lt;USER_EMAIL&gt;", "name": "&lt;NAME&gt;", "phone": "&lt;USER_PHONE&gt;, "domain": "&lt;ORGANISATION_DOMAIN&gt;", "organisation_name": "&lt;NAME_OF_ORGANISATION&gt;""\n}'\n</code></pre>\n<h5 class="toc-header" id="response-201"><a href="#response-201" class="toc-anchor">¶</a> Response (201):</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">{\n   "user": {\n       "id": 3,\n       "name": "&lt;USER_NAME&gt;",\n       "email": "&lt;USER_EMAIL&gt;",\n       "username": "&lt;USER_EMAIL&gt;",\n       "is_active": true,\n       "phone": "&lt;USER_PHONE&gt;",\n       "is_email_verified": false,\n       "is_phone_verified": false,\n       "is_superuser": false\n   },\n   "organisation": {\n       "id": &lt;ORGANISATION_ID&gt;,\n       "token": "&lt;ORGANISATION_TOKEN&gt;",\n       "name": "",\n       "domain": "&lt;ORGANISATION_DOMAIN&gt;",\n       "currency": "",\n       "country_code": "",\n       "is_active": true,\n       "logo": "",\n       "wid": null,\n       "created_at": "2024-07-10T09:56:21.863123+00:00",\n       "modified_at": "2024-07-10T09:56:21.862801+00:00",\n       "referer": null,\n       "features_enabled": ""\n   },\n   "code": 2011,\n   "message": "Created"\n}\n</code></pre>\n<h5 class="toc-header" id="response-400"><a href="#response-400" class="toc-anchor">¶</a> Response (400):</h5>\n<p>User:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">\n{\n   "code": 4009,\n   "message": "Email Already exists"\n}\n</code></pre>\n<p>Organisation:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-json">{\n   "code": 40010,\n   "message": "Organisation Exists. Cannot assign existing Organisations."\n}\n</code></pre>\n<hr>\n<h3 class="toc-header" id="webhook"><a href="#webhook" class="toc-anchor">¶</a> Webhook:</h3>\n<h5 class="toc-header" id="create"><a href="#create" class="toc-anchor">¶</a> Create:</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Method: POST\nURL: https://svc.nitrocommerce.ai/v1/rest/&lt;your_platform_name&gt;/integration\nData: {"org_id":&lt;organisation_id&gt;,"active":true,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true}}\nHeaders: \n- Content-Type: application/json\n- Authorization: Bearer &lt;platform_account_user_bearer_token&gt;\n</code></pre>\n<h5 class="toc-header" id="curl-2"><a href="#curl-2" class="toc-anchor">¶</a> Curl:</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-curl">curl 'https://svc.nitrocommerce.ai/v1/rest/integration' \\\n-X 'POST' \\\n-H 'Authorization: Bearer &lt;platform_account_user_bearer_token&gt;' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{"org_id":&lt;organisation_id&gt;,"active":true,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true}}'\n</code></pre>\n<hr>\n<h5 class="toc-header" id="update"><a href="#update" class="toc-anchor">¶</a> Update:</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-">Method: PUT\nURL: https://svc.nitrocommerce.ai/v1/rest/&lt;your_platform_name&gt;/integration\nData: {"org_id":&lt;organisation_id&gt;,"active":true/false,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true},"id":&lt;WEBHOOK_ID&gt;}\n\nHeaders: \n- Content-Type: application/json\n- Authorization: Bearer &lt;platform_account_user_bearer_token&gt;\n</code></pre>\n<h5 class="toc-header" id="curl-3"><a href="#curl-3" class="toc-anchor">¶</a> Curl:</h5>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-curl">\ncurl 'https://svc.nitrocommerce.ai/v1/rest/integration' \\\n  -X 'PUT' \\\n  -H 'Authorization: Bearer &lt;platform_account_user_bearer_token&gt;' \\\n  -H 'Content-Type: application/json' \\\n  --data-raw '{"org_id":&lt;organisation_id&gt;,"active":true/false,"type":"WEBHOOK","data":{"endpoint":"https://somewebhook.com","authToken":"abXXefg","httpTimeout":"3","do_events":true,"do_contacts":true},"id":&lt;WEBHOOK_ID&gt;}'\n</code></pre>\n	[{"title":"Nitro Integration API Document","anchor":"#nitro-integration-api-document","children":[]}]	markdown	2024-07-16T10:06:23.492Z	2024-07-16T10:55:20.427Z	markdown	en	3	3	{"js":"","css":""}
12	android-sdk	23b2db2ae1ffd682acdb47b91b31d1905f733610	Nitro Android SDK		f	f	\N			# Nitrox SDK Documentation Guide\n\n## Overview\nNitrox SDK is designed to help you track various user events in your Android application. This guide will walk you through the initialization process and how to use the SDK to track specific events.\n\n## 1. Initialization\n\n### Add Nitrox SDK to your project\nAdd dependency in build.gradle (app level):\n```gradle\nimplementation '<ADD_REPOSITORY PATH>'\n```\n\n### Extend NitroxApplication\nCreate a class that extends `NitroxApplication` and initialize the Nitrox SDK in the `onCreate` method.\n\n```java\npackage com.example.nitroxsdkpocapp;\n\nimport com.nitrox.sdk.Nitrox;\nimport com.nitrox.sdk.base.NitroxApplication;\n\npublic class MyExtendedApplication extends NitroxApplication {\n\n    @Override\n    public void onCreate() {\n        super.onCreate(); // Always call this method first before writing any other logic.\n        Nitrox.initialize("<ORG_TOKEN>", this);\n        new android.os.Handler(android.os.Looper.getMainLooper()).postDelayed(new Runnable() {\n            @Override\n            public void run() {\n                NitroDeviceMapper nitroDeviceMapper = new NitroDeviceMapper();\n                nitroDeviceMapper.push();\n            }\n        }, 100);\n    }\n}\n```\n\n### Update Manifest\n\n```xml\n<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="....>\n  <application android:name=".MyExtendedApplication"...>\n    <activity android:name= ......></activity>\n\t</application>\n</manifest>\n```\n\n**Congratulations! You have successfully integrated Nitrox SDK in your app. Let us guide you through usage of this SDK.**\n\n## 2. Identifying Users\n\n### User Identification Events\nTo identify users, such as during registration, login, or when they provide personal details during checkout, use the IdentifyMapper as follows:\n\n```java\nIdentifyMapper identifyMapper = new IdentifyMapper();\nidentifyMapper.setFullName("<FULL_NAME>");\nidentifyMapper.setEmail("<EMAIL>");\nidentifyMapper.setPhone("<PHONE>");\nidentifyMapper.push();\n```\nReplace ```<FULL_NAME>```, ```<EMAIL>```, and ```<PHONE>``` with the user's details.\n\n## 3. Tracking Events\n\n### 3.1 View Event\nTrack when a user views a page:\n\n```java\nNitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("view");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("page", "https://someurl.com"); // replace with your deeplink\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n```\n\n### 3.2 Add to Cart Event\nTrack when a user adds items to the cart:\n\n```java\nNitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("addtocart");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("cart_url", "https://someurl.com");\n    eventData.put("product_id", 123456);\n    JSONArray lineItems = new JSONArray();\n    JSONObject lineItem = new JSONObject();\n    lineItem.put("quantity", 1);\n    lineItem.put("title", "Black Box");\n    lineItem.put("line_price", 24.00);\n    lineItem.put("id", "987654"); // Variant ID\n    lineItem.put("product_id", "1234567");\n    lineItem.put("image_url", "variant or product image url");\n    lineItems.put(lineItem);\n    eventData.put("line_items", lineItems);\n    eventData.put("cart_value", 24.00);\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n```\n\n### 3.3 Checkout Event\nTrack when a user proceeds to checkout:\n\n```java\nNitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("checkout");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("checkout", "<checkout_url>");\n    JSONArray items = new JSONArray();\n    JSONObject item = new JSONObject();\n    item.put("product_id", 12345);\n    item.put("price", "12/-");\n    item.put("product_url", "https://someurl.com/product_id");\n    items.put(item);\n    eventData.put("items", items);\n    eventData.put("cart_value", <total_checkout_amount>);\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n```\n\n### 3.4 Buy Event\nTrack when a user completes a purchase:\n\n```java\nNitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("buy");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("checkout_url", "https://someurl.com");\n    JSONArray items = new JSONArray();\n    JSONObject item = new JSONObject();\n    item.put("product_id", 12345);\n    item.put("price", "12/-");\n    item.put("product_url", "https://someurl.com/product_id");\n    items.put(item);\n    eventData.put("items", items);\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n```\n\n### 3.5 Product View Event\nTrack when a user views a product:\n\n```java\nNitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("product_view");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("product_id", 12345);\n    eventData.put("price", "12/-");\n    eventData.put("product_url", "https://someurl.com/product_id");\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n```\n\n### 3.6 Category View Event\nTrack when a user views a category:\n\n```java\nNitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("category_view");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("category", "fashion");\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n```	<h1 class="toc-header" id="nitrox-sdk-documentation-guide"><a href="#nitrox-sdk-documentation-guide" class="toc-anchor">¶</a> Nitrox SDK Documentation Guide</h1>\n<h2 class="toc-header" id="overview"><a href="#overview" class="toc-anchor">¶</a> Overview</h2>\n<p>Nitrox SDK is designed to help you track various user events in your Android application. This guide will walk you through the initialization process and how to use the SDK to track specific events.</p>\n<h2 class="toc-header" id="h-1-initialization"><a href="#h-1-initialization" class="toc-anchor">¶</a> 1. Initialization</h2>\n<h3 class="toc-header" id="add-nitrox-sdk-to-your-project"><a href="#add-nitrox-sdk-to-your-project" class="toc-anchor">¶</a> Add Nitrox SDK to your project</h3>\n<p>Add dependency in build.gradle (app level):</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-gradle">implementation '&lt;ADD_REPOSITORY PATH&gt;'\n</code></pre>\n<h3 class="toc-header" id="extend-nitroxapplication"><a href="#extend-nitroxapplication" class="toc-anchor">¶</a> Extend NitroxApplication</h3>\n<p>Create a class that extends <code>NitroxApplication</code> and initialize the Nitrox SDK in the <code>onCreate</code> method.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">package com.example.nitroxsdkpocapp;\n\nimport com.nitrox.sdk.Nitrox;\nimport com.nitrox.sdk.base.NitroxApplication;\n\npublic class MyExtendedApplication extends NitroxApplication {\n\n    @Override\n    public void onCreate() {\n        super.onCreate(); // Always call this method first before writing any other logic.\n        Nitrox.initialize("&lt;ORG_TOKEN&gt;", this);\n        new android.os.Handler(android.os.Looper.getMainLooper()).postDelayed(new Runnable() {\n            @Override\n            public void run() {\n                NitroDeviceMapper nitroDeviceMapper = new NitroDeviceMapper();\n                nitroDeviceMapper.push();\n            }\n        }, 100);\n    }\n}\n</code></pre>\n<h3 class="toc-header" id="update-manifest"><a href="#update-manifest" class="toc-anchor">¶</a> Update Manifest</h3>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-xml">&lt;manifest xmlns:android="http://schemas.android.com/apk/res/android" package="....&gt;\n  &lt;application android:name=".MyExtendedApplication"...&gt;\n    &lt;activity android:name= ......&gt;&lt;/activity&gt;\n    &lt;/application&gt;\n&lt;/manifest&gt;\n</code></pre>\n<p><strong>Congratulations! You have successfully integrated Nitrox SDK in your app. Let us guide you through usage of this SDK.</strong></p>\n<h2 class="toc-header" id="h-2-identifying-users"><a href="#h-2-identifying-users" class="toc-anchor">¶</a> 2. Identifying Users</h2>\n<h3 class="toc-header" id="user-identification-events"><a href="#user-identification-events" class="toc-anchor">¶</a> User Identification Events</h3>\n<p>To identify users, such as during registration, login, or when they provide personal details during checkout, use the IdentifyMapper as follows:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">IdentifyMapper identifyMapper = new IdentifyMapper();\nidentifyMapper.setFullName("&lt;FULL_NAME&gt;");\nidentifyMapper.setEmail("&lt;EMAIL&gt;");\nidentifyMapper.setPhone("&lt;PHONE&gt;");\nidentifyMapper.push();\n</code></pre>\n<p>Replace <code>&lt;FULL_NAME&gt;</code>, <code>&lt;EMAIL&gt;</code>, and <code>&lt;PHONE&gt;</code> with the user's details.</p>\n<h2 class="toc-header" id="h-3-tracking-events"><a href="#h-3-tracking-events" class="toc-anchor">¶</a> 3. Tracking Events</h2>\n<h3 class="toc-header" id="h-31-view-event"><a href="#h-31-view-event" class="toc-anchor">¶</a> 3.1 View Event</h3>\n<p>Track when a user views a page:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">NitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("view");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("page", "https://someurl.com"); // replace with your deeplink\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n</code></pre>\n<h3 class="toc-header" id="h-32-add-to-cart-event"><a href="#h-32-add-to-cart-event" class="toc-anchor">¶</a> 3.2 Add to Cart Event</h3>\n<p>Track when a user adds items to the cart:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">NitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("addtocart");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("cart_url", "https://someurl.com");\n    eventData.put("product_id", 123456);\n    JSONArray lineItems = new JSONArray();\n    JSONObject lineItem = new JSONObject();\n    lineItem.put("quantity", 1);\n    lineItem.put("title", "Black Box");\n    lineItem.put("line_price", 24.00);\n    lineItem.put("id", "987654"); // Variant ID\n    lineItem.put("product_id", "1234567");\n    lineItem.put("image_url", "variant or product image url");\n    lineItems.put(lineItem);\n    eventData.put("line_items", lineItems);\n    eventData.put("cart_value", 24.00);\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n</code></pre>\n<h3 class="toc-header" id="h-33-checkout-event"><a href="#h-33-checkout-event" class="toc-anchor">¶</a> 3.3 Checkout Event</h3>\n<p>Track when a user proceeds to checkout:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">NitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("checkout");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("checkout", "&lt;checkout_url&gt;");\n    JSONArray items = new JSONArray();\n    JSONObject item = new JSONObject();\n    item.put("product_id", 12345);\n    item.put("price", "12/-");\n    item.put("product_url", "https://someurl.com/product_id");\n    items.put(item);\n    eventData.put("items", items);\n    eventData.put("cart_value", &lt;total_checkout_amount&gt;);\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n</code></pre>\n<h3 class="toc-header" id="h-34-buy-event"><a href="#h-34-buy-event" class="toc-anchor">¶</a> 3.4 Buy Event</h3>\n<p>Track when a user completes a purchase:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">NitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("buy");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("checkout_url", "https://someurl.com");\n    JSONArray items = new JSONArray();\n    JSONObject item = new JSONObject();\n    item.put("product_id", 12345);\n    item.put("price", "12/-");\n    item.put("product_url", "https://someurl.com/product_id");\n    items.put(item);\n    eventData.put("items", items);\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n</code></pre>\n<h3 class="toc-header" id="h-35-product-view-event"><a href="#h-35-product-view-event" class="toc-anchor">¶</a> 3.5 Product View Event</h3>\n<p>Track when a user views a product:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">NitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("product_view");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("product_id", 12345);\n    eventData.put("price", "12/-");\n    eventData.put("product_url", "https://someurl.com/product_id");\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n</code></pre>\n<h3 class="toc-header" id="h-36-category-view-event"><a href="#h-36-category-view-event" class="toc-anchor">¶</a> 3.6 Category View Event</h3>\n<p>Track when a user views a category:</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-java">NitroEventMapper nitroEventMapper = new NitroEventMapper();\nnitroEventMapper.setEventName("category_view");\n\nJSONObject eventData = new JSONObject();\ntry {\n    eventData.put("category", "fashion");\n} catch (JSONException e) {\n    e.printStackTrace();\n}\n\nnitroEventMapper.setEventValue(eventData);\nnitroEventMapper.push();\n</code></pre>\n	[{"title":"Nitrox SDK Documentation Guide","anchor":"#nitrox-sdk-documentation-guide","children":[{"title":"Overview","anchor":"#overview","children":[]},{"title":"1. Initialization","anchor":"#h-1-initialization","children":[{"title":"Add Nitrox SDK to your project","anchor":"#add-nitrox-sdk-to-your-project","children":[]},{"title":"Extend NitroxApplication","anchor":"#extend-nitroxapplication","children":[]},{"title":"Update Manifest","anchor":"#update-manifest","children":[]}]},{"title":"2. Identifying Users","anchor":"#h-2-identifying-users","children":[{"title":"User Identification Events","anchor":"#user-identification-events","children":[]}]},{"title":"3. Tracking Events","anchor":"#h-3-tracking-events","children":[{"title":"3.1 View Event","anchor":"#h-31-view-event","children":[]},{"title":"3.2 Add to Cart Event","anchor":"#h-32-add-to-cart-event","children":[]},{"title":"3.3 Checkout Event","anchor":"#h-33-checkout-event","children":[]},{"title":"3.4 Buy Event","anchor":"#h-34-buy-event","children":[]},{"title":"3.5 Product View Event","anchor":"#h-35-product-view-event","children":[]},{"title":"3.6 Category View Event","anchor":"#h-36-category-view-event","children":[]}]}]}]	markdown	2024-08-05T12:56:49.274Z	2024-08-06T18:31:46.576Z	markdown	en	8	8	{"js":"","css":""}
16	quick-start-guide	fcd1c9361d3d6a4f98c69d10c992f901361df942	Quick Start Guide	This document contains detailed information on how to get started with NitroX	f	t	\N			<h1>NitroX - Quick Start Guide</h1>\n<p>&nbsp;</p>\n<p><strong>Overview:</strong></p>\n<p>Our Quick Start Guide is designed to help you set up and begin using our platform effectively. This guide will walk you through the essential steps to integrate NitroX with your website, configure key features, and start optimizing your e-commerce strategy.&nbsp;</p>\n<p>You will accomplish this in three steps through the NitroX dashboard:</p>\n<ol>\n  <li><strong>Integrate NitroX with your website</strong> to start identifying anonymous visitors and capturing valuable data.</li>\n  <li><strong>Configure key features</strong> like Consent Management, High-Intent Users, and Forever Links to optimize your sales funnel.</li>\n  <li><strong>Monitor and analyze user behavior</strong> with Live Activity Monitoring and Contacts Management to refine your marketing strategies and increase conversions.</li>\n</ol>\n<p>Follow these instructions to make the most out of NitroX and start turning your website traffic into valuable insights and conversions.</p>\n<p><strong>1. a) If you own a Shopify Website: Install the ‘SuperAcquire’ App via the Shopify App Store</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Log in to your Shopify account and open <a href="https://apps.shopify.com/superacquire-grow-your-revenue">SuperAcquire</a> on your App Store<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/shopify_store_app_installation.png"></figure>\n<ul>\n  <li><strong>Step 2:</strong> Click on the “Install” button.</li>\n  <li><strong>Step 3:</strong> Review access required and click on “Install app”</li>\n  <li><strong>Step 4:</strong> You will now be redirected to the Dashboard of NitroX</li>\n</ul>\n<p><strong>1. b) If you own a non-Shopify Website: Create an account&nbsp;</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Register your store on <a href="x.nitrocommerce.ai/register">NitroX</a> by following the sign-up process<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/sign-up_page.png"></figure>\n<ul>\n  <li><strong>Step 2:</strong> Once account has been successfully registered login to <a href="https://x.nitrocommerce.ai/login">NitroX</a> account</li>\n</ul>\n<p><strong>2. Integrate with your Website: For non-Shopify</strong></p>\n<ul>\n  <li><strong>Step 1: </strong>Login to your <a href="https://x.nitrocommerce.ai/login">NitroX</a> account</li>\n  <li><strong>Step 2:</strong> Navigate to the “Install” section on the left hand side menu</li>\n  <li><strong>Step 3:</strong> Select “Manual Integration” and copy the NitroX code provided<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/manual_integration_code.png"></figure>\n<ul>\n  <li><strong>Step 4:</strong> Paste the NitroX code into the header section of your website's HTML. This code should be added to every page where you want to track user activity.</li>\n  <li><strong>Step 5:</strong> Return to x.nitrocommerce.ai/install where you will now be able to see the Integration Status and events that are being received by the platform<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/screenshot_2024-09-02_at_7.13.12_pm.png"></figure>\n<p><strong>3. Configure Key Features</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Consent Management (Pre-fill Capture)<ul>\n      <li>Go to <strong>Consent Management</strong></li>\n      <li>Select a template design that resonates with your brand the best<br>&nbsp;</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/cms.png"></figure>\n<ul>\n  <li>Configure the Template settings - Content, Discount (if any) details and URL settings; Click on <strong>Save</strong> to enable the template for your website</li>\n</ul>\n<figure class="image"><img src="/screenshot_2024-09-05_at_1.25.59_pm.png"></figure>\n<p>&nbsp;</p>\n<ul>\n  <li><strong>Step 2: </strong>High-Intent Users<ul>\n      <li>Go to <strong>High Intent Users</strong><br>&nbsp;</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/screenshot_2024-09-09_at_12.11.19_pm.png"></figure>\n<ul>\n  <li>As this is a <strong>locked</strong> feature, please contact <strong>sales@getnitro.co</strong> to enable this feature first</li>\n  <li>Once enabled <strong>High Intent Users </strong>section will populate data points like comprehensive customer information, cart value, website activity tracking, average e-commerce score (coming soon) and more. These data points will help you track user behaviour, personalise engagement communications and improve conversion rates across the E-commerce Sales Funnel<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/hiu_overview.png"></figure>\n<p>&nbsp;</p>\n<ul>\n  <li><strong>Step 3: </strong>Forever Links</li>\n</ul>\n<figure class="image"><img src="/forever_link.png"></figure>\n<ul>\n  <li>Go to <strong>Forever Links</strong></li>\n  <li>Click on “Create Link”</li>\n</ul>\n<figure class="image"><img src="/configure_forever_links.png"></figure>\n<ul>\n  <li>Configure the Link settings based on the type of ad campaign you want to run</li>\n  <li>Provide a “Destination Link” - This could be any webpage that you want your users to be redirected from the ads</li>\n  <li>Based on how you would like to track engagement and conversions, you may choose to set up UTM parameters, Facebook Tracking ID or GTM Tracking ID<br>&nbsp;</li>\n  <li><strong>Step 4:</strong> Integrations<ul>\n      <li>This section allows you to connect your NitroX account to any mar-tech platform being used for retention marketing</li>\n      <li>We have native integrations with certain platforms like Limechat, BiteSpeed, Contlo, Interakt and more. If you're using any of these partners, simply enable the respective integration and input the required information<br><i>Please note you might have to reach out to your POC with the retention marketing tool for additional details</i></li>\n      <li>In case you don't find your CRM platform in this list, you can connect your NitroX account via Webhook. Please reach out to Nitro team for further information</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/integrations.png"></figure>\n<ul>\n  <li><strong>Step 5:</strong> Live Activity Monitoring<ul>\n      <li>Navigate to the “Live” Section of the Dashboard</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/live.png"></figure>\n<ul>\n  <li>Set up and monitor real-time user activity to understand current engagement and behaviour on your website</li>\n  <li><strong>Step 6:</strong> Contacts Management<br>\n    <ul>\n      <li>Go to “Contacts” on your NitroX dashboard</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/contacts_.png"></figure>\n<ul>\n  <li>Configure and download contacts data for use in your marketing campaigns</li>\n</ul>\n<p><strong>4. Start Monitoring and Optimizing</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Review Performance Metrics<ul>\n      <li>Regularly check the NitroX dashboard to view performance metrics and user data</li>\n    </ul>\n  </li>\n  <li><strong>Step 2:</strong> Adjust Strategies<ul>\n      <li>Use insights from NitroX to refine your marketing strategies and optimize your e-commerce funnel. Implement changes based on real-time data and performance trends</li>\n    </ul>\n  </li>\n</ul>\n<p>Congratulations on getting started with NitroX! If you encounter any issues or need additional support, please refer to our help center or contact our support team. With NitroX, you’re equipped to turn your website traffic into actionable insights and successful conversions. Happy optimizing!</p>\n<p><br><br>&nbsp;</p>\n<p>&nbsp;</p>\n<p>&nbsp;</p>\n	<h1 class="toc-header" id="nitrox-quick-start-guide"><a href="#nitrox-quick-start-guide" class="toc-anchor">¶</a> NitroX - Quick Start Guide</h1>\n<p>&nbsp;</p>\n<p><strong>Overview:</strong></p>\n<p>Our Quick Start Guide is designed to help you set up and begin using our platform effectively. This guide will walk you through the essential steps to integrate NitroX with your website, configure key features, and start optimizing your e-commerce strategy.&nbsp;</p>\n<p>You will accomplish this in three steps through the NitroX dashboard:</p>\n<ol>\n  <li><strong>Integrate NitroX with your website</strong> to start identifying anonymous visitors and capturing valuable data.</li>\n  <li><strong>Configure key features</strong> like Consent Management, High-Intent Users, and Forever Links to optimize your sales funnel.</li>\n  <li><strong>Monitor and analyze user behavior</strong> with Live Activity Monitoring and Contacts Management to refine your marketing strategies and increase conversions.</li>\n</ol>\n<p>Follow these instructions to make the most out of NitroX and start turning your website traffic into valuable insights and conversions.</p>\n<p><strong>1. a) If you own a Shopify Website: Install the ‘SuperAcquire’ App via the Shopify App Store</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Log in to your Shopify account and open <a class="is-external-link" href="https://apps.shopify.com/superacquire-grow-your-revenue">SuperAcquire</a> on your App Store<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/shopify_store_app_installation.png"></figure>\n<ul>\n  <li><strong>Step 2:</strong> Click on the “Install” button.</li>\n  <li><strong>Step 3:</strong> Review access required and click on “Install app”</li>\n  <li><strong>Step 4:</strong> You will now be redirected to the Dashboard of NitroX</li>\n</ul>\n<p><strong>1. b) If you own a non-Shopify Website: Create an account&nbsp;</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Register your store on <a class="is-asset-link" href="x.nitrocommerce.ai/register">NitroX</a> by following the sign-up process<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/sign-up_page.png"></figure>\n<ul>\n  <li><strong>Step 2:</strong> Once account has been successfully registered login to <a class="is-external-link" href="https://x.nitrocommerce.ai/login">NitroX</a> account</li>\n</ul>\n<p><strong>2. Integrate with your Website: For non-Shopify</strong></p>\n<ul>\n  <li><strong>Step 1: </strong>Login to your <a class="is-external-link" href="https://x.nitrocommerce.ai/login">NitroX</a> account</li>\n  <li><strong>Step 2:</strong> Navigate to the “Install” section on the left hand side menu</li>\n  <li><strong>Step 3:</strong> Select “Manual Integration” and copy the NitroX code provided<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/manual_integration_code.png"></figure>\n<ul>\n  <li><strong>Step 4:</strong> Paste the NitroX code into the header section of your website's HTML. This code should be added to every page where you want to track user activity.</li>\n  <li><strong>Step 5:</strong> Return to x.nitrocommerce.ai/install where you will now be able to see the Integration Status and events that are being received by the platform<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/screenshot_2024-09-02_at_7.13.12_pm.png"></figure>\n<p><strong>3. Configure Key Features</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Consent Management (Pre-fill Capture)<ul>\n      <li>Go to <strong>Consent Management</strong></li>\n      <li>Select a template design that resonates with your brand the best<br>&nbsp;</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/cms.png"></figure>\n<ul>\n  <li>Configure the Template settings - Content, Discount (if any) details and URL settings; Click on <strong>Save</strong> to enable the template for your website</li>\n</ul>\n<figure class="image"><img src="/screenshot_2024-09-05_at_1.25.59_pm.png"></figure>\n<p>&nbsp;</p>\n<ul>\n  <li><strong>Step 2: </strong>High-Intent Users<ul>\n      <li>Go to <strong>High Intent Users</strong><br>&nbsp;</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/screenshot_2024-09-09_at_12.11.19_pm.png"></figure>\n<ul>\n  <li>As this is a <strong>locked</strong> feature, please contact <strong>sales@getnitro.co</strong> to enable this feature first</li>\n  <li>Once enabled <strong>High Intent Users </strong>section will populate data points like comprehensive customer information, cart value, website activity tracking, average e-commerce score (coming soon) and more. These data points will help you track user behaviour, personalise engagement communications and improve conversion rates across the E-commerce Sales Funnel<br>&nbsp;</li>\n</ul>\n<figure class="image"><img src="/hiu_overview.png"></figure>\n<p>&nbsp;</p>\n<ul>\n  <li><strong>Step 3: </strong>Forever Links</li>\n</ul>\n<figure class="image"><img src="/forever_link.png"></figure>\n<ul>\n  <li>Go to <strong>Forever Links</strong></li>\n  <li>Click on “Create Link”</li>\n</ul>\n<figure class="image"><img src="/configure_forever_links.png"></figure>\n<ul>\n  <li>Configure the Link settings based on the type of ad campaign you want to run</li>\n  <li>Provide a “Destination Link” - This could be any webpage that you want your users to be redirected from the ads</li>\n  <li>Based on how you would like to track engagement and conversions, you may choose to set up UTM parameters, Facebook Tracking ID or GTM Tracking ID<br>&nbsp;</li>\n  <li><strong>Step 4:</strong> Integrations<ul>\n      <li>This section allows you to connect your NitroX account to any mar-tech platform being used for retention marketing</li>\n      <li>We have native integrations with certain platforms like Limechat, BiteSpeed, Contlo, Interakt and more. If you're using any of these partners, simply enable the respective integration and input the required information<br><i>Please note you might have to reach out to your POC with the retention marketing tool for additional details</i></li>\n      <li>In case you don't find your CRM platform in this list, you can connect your NitroX account via Webhook. Please reach out to Nitro team for further information</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/integrations.png"></figure>\n<ul>\n  <li><strong>Step 5:</strong> Live Activity Monitoring<ul>\n      <li>Navigate to the “Live” Section of the Dashboard</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/live.png"></figure>\n<ul>\n  <li>Set up and monitor real-time user activity to understand current engagement and behaviour on your website</li>\n  <li><strong>Step 6:</strong> Contacts Management<br>\n    <ul>\n      <li>Go to “Contacts” on your NitroX dashboard</li>\n    </ul>\n  </li>\n</ul>\n<figure class="image"><img src="/contacts_.png"></figure>\n<ul>\n  <li>Configure and download contacts data for use in your marketing campaigns</li>\n</ul>\n<p><strong>4. Start Monitoring and Optimizing</strong></p>\n<ul>\n  <li><strong>Step 1:</strong> Review Performance Metrics<ul>\n      <li>Regularly check the NitroX dashboard to view performance metrics and user data</li>\n    </ul>\n  </li>\n  <li><strong>Step 2:</strong> Adjust Strategies<ul>\n      <li>Use insights from NitroX to refine your marketing strategies and optimize your e-commerce funnel. Implement changes based on real-time data and performance trends</li>\n    </ul>\n  </li>\n</ul>\n<p>Congratulations on getting started with NitroX! If you encounter any issues or need additional support, please refer to our help center or contact our support team. With NitroX, you’re equipped to turn your website traffic into actionable insights and successful conversions. Happy optimizing!</p>\n<p><br><br>&nbsp;</p>\n<p>&nbsp;</p>\n<p>&nbsp;</p>\n	[{"title":"NitroX - Quick Start Guide","anchor":"#nitrox-quick-start-guide","children":[]}]	html	2024-09-02T13:49:45.352Z	2024-09-09T09:37:40.575Z	ckeditor	en	10	10	{"js":"","css":""}
17	consent-management	287bfd88e36ea981a654c6e8b9fbe2fc6b324061	Consent Management	This document consists detailed description of the Consent Management Feature	f	t	\N			<h1>NitroX - Consent Management</h1>\n<p>&nbsp;</p>\n<p><strong>Overview:</strong></p>\n<p>The Consent Management feature in NitroX is designed to streamline and optimize the process of obtaining and managing user consent for data collection on your e-commerce website. This feature simplifies user interactions, ensures compliance with data protection regulations, and enhances the overall efficiency of your data management practices. Enabling this feature has proven to improve overall identification rate by approximately 30%. It also allows more personalised engagement, especially in the Middle-of-the-Funnel.&nbsp;</p>\n<figure class="image"><img src="/cms_new_1.png"></figure>\n<p><strong>Key Functions:</strong></p>\n<ol>\n  <li><strong>Pre-fill Capture:</strong> Automatically populate identified user's phone number with non-intrusive pop-up design</li>\n  <li><strong>Consent Tracking:</strong> Log user consent and actively track status &amp; website activity in compliance with data privacy laws</li>\n  <li><strong>Seamless setup:</strong> Configure pop-up details to resonate with your brand's theme (like color scheme) so that your end user has a smooth experience</li>\n</ol>\n<p><strong>Types of Consent Management:</strong></p>\n<p><strong>1. Prefilled Templates:</strong></p>\n<p>These are discount or non-discount based consent management templates. They consist of 2 steps: a) Phone number pre-fill and submission and b) Success Message consisting of a “Welcome” msg and/or “Coupon code” details</p>\n<figure class="image"><img src="/prefilled.png"></figure>\n<p><strong>2. Auto Login Templates:</strong></p>\n<p>These are OTP-based consent management templates which not only pre-fill identified user phone number, but also verify the same upon submission via a One-Time Password. The OTP is generated, sent &amp; validated by Nitro system hence it is hassle-free for you.&nbsp;</p>\n<p>These templates don't just manage user consent, they also auto-login the user to your website. This helps in logged website tracking as well as targeted recommendations and product bundling</p>\n<figure class="image"><img src="/auto_login.png"></figure>\n<p><strong>How does Auto Login work?</strong></p>\n<ol>\n  <li>Configure the OTP Verified Coupon template</li>\n  <li>Once configured, you will be able to experience the following activated on your website<ul>\n      <li><strong>Step 1: </strong>Phone Number submission</li>\n    </ul>\n  </li>\n</ol>\n<figure class="image"><img src="/otp_verified_template.png"></figure>\n<ul>\n  <li><strong>Step 2:</strong> OTP Verification</li>\n</ul>\n<figure class="image"><img src="/otp_verification.png"></figure>\n<ul>\n  <li><strong>Step 3:</strong> Success Message</li>\n</ul>\n<figure class="image"><img src="/otp_success.png"></figure>\n<p>Once OTP is successfully verified, user will be <strong>auto logged in</strong> to your website.</p>\n<figure class="image"><img src="/auto-logged_in.png"></figure>\n<p>&nbsp;</p>\n<p><strong>Benefits:</strong></p>\n<ul>\n  <li><strong>Enhanced User Experience:</strong> By pre-filling user phone number, NitroX simplifies consent management processes and decreases discrepancy. This leads to increased identification rate as well as hyper personalised engagement</li>\n  <li><strong>Improved Data Accuracy:</strong> Accurate and timely consent records enhance the quality and reliability of the collected data, facilitating better marketing and personalization strategies</li>\n  <li><strong>Regulatory Compliance:</strong> Ensures adherence to data privacy regulations, including the Digital Personal Data Protection (DPDP) Act of 2023, by maintaining clear and accurate consent records.</li>\n  <li><strong>Efficient Data Management:</strong> Streamlines the management of user consent and integrates with CRM systems for better data utilization and targeted marketing efforts.</li>\n</ul>\n<p><strong>Conclusion:</strong></p>\n<p>The Consent Management feature of NitroX is essential for e-commerce businesses looking to efficiently handle user consent while maintaining compliance with privacy regulations, ultimately supporting better data practices and improved customer interactions.</p>\n<p>&nbsp;</p>\n	<h1 class="toc-header" id="nitrox-consent-management"><a href="#nitrox-consent-management" class="toc-anchor">¶</a> NitroX - Consent Management</h1>\n<p>&nbsp;</p>\n<p><strong>Overview:</strong></p>\n<p>The Consent Management feature in NitroX is designed to streamline and optimize the process of obtaining and managing user consent for data collection on your e-commerce website. This feature simplifies user interactions, ensures compliance with data protection regulations, and enhances the overall efficiency of your data management practices. Enabling this feature has proven to improve overall identification rate by approximately 30%. It also allows more personalised engagement, especially in the Middle-of-the-Funnel.&nbsp;</p>\n<figure class="image"><img src="/cms_new_1.png"></figure>\n<p><strong>Key Functions:</strong></p>\n<ol>\n  <li><strong>Pre-fill Capture:</strong> Automatically populate identified user's phone number with non-intrusive pop-up design</li>\n  <li><strong>Consent Tracking:</strong> Log user consent and actively track status &amp; website activity in compliance with data privacy laws</li>\n  <li><strong>Seamless setup:</strong> Configure pop-up details to resonate with your brand's theme (like color scheme) so that your end user has a smooth experience</li>\n</ol>\n<p><strong>Types of Consent Management:</strong></p>\n<p><strong>1. Prefilled Templates:</strong></p>\n<p>These are discount or non-discount based consent management templates. They consist of 2 steps: a) Phone number pre-fill and submission and b) Success Message consisting of a “Welcome” msg and/or “Coupon code” details</p>\n<figure class="image"><img src="/prefilled.png"></figure>\n<p><strong>2. Auto Login Templates:</strong></p>\n<p>These are OTP-based consent management templates which not only pre-fill identified user phone number, but also verify the same upon submission via a One-Time Password. The OTP is generated, sent &amp; validated by Nitro system hence it is hassle-free for you.&nbsp;</p>\n<p>These templates don't just manage user consent, they also auto-login the user to your website. This helps in logged website tracking as well as targeted recommendations and product bundling</p>\n<figure class="image"><img src="/auto_login.png"></figure>\n<p><strong>How does Auto Login work?</strong></p>\n<ol>\n  <li>Configure the OTP Verified Coupon template</li>\n  <li>Once configured, you will be able to experience the following activated on your website<ul>\n      <li><strong>Step 1: </strong>Phone Number submission</li>\n    </ul>\n  </li>\n</ol>\n<figure class="image"><img src="/otp_verified_template.png"></figure>\n<ul>\n  <li><strong>Step 2:</strong> OTP Verification</li>\n</ul>\n<figure class="image"><img src="/otp_verification.png"></figure>\n<ul>\n  <li><strong>Step 3:</strong> Success Message</li>\n</ul>\n<figure class="image"><img src="/otp_success.png"></figure>\n<p>Once OTP is successfully verified, user will be <strong>auto logged in</strong> to your website.</p>\n<figure class="image"><img src="/auto-logged_in.png"></figure>\n<p>&nbsp;</p>\n<p><strong>Benefits:</strong></p>\n<ul>\n  <li><strong>Enhanced User Experience:</strong> By pre-filling user phone number, NitroX simplifies consent management processes and decreases discrepancy. This leads to increased identification rate as well as hyper personalised engagement</li>\n  <li><strong>Improved Data Accuracy:</strong> Accurate and timely consent records enhance the quality and reliability of the collected data, facilitating better marketing and personalization strategies</li>\n  <li><strong>Regulatory Compliance:</strong> Ensures adherence to data privacy regulations, including the Digital Personal Data Protection (DPDP) Act of 2023, by maintaining clear and accurate consent records.</li>\n  <li><strong>Efficient Data Management:</strong> Streamlines the management of user consent and integrates with CRM systems for better data utilization and targeted marketing efforts.</li>\n</ul>\n<p><strong>Conclusion:</strong></p>\n<p>The Consent Management feature of NitroX is essential for e-commerce businesses looking to efficiently handle user consent while maintaining compliance with privacy regulations, ultimately supporting better data practices and improved customer interactions.</p>\n<p>&nbsp;</p>\n	[{"title":"NitroX - Consent Management","anchor":"#nitrox-consent-management","children":[]}]	html	2024-09-09T10:04:55.765Z	2024-09-09T11:17:47.519Z	ckeditor	en	10	10	{"js":"","css":""}
2	integration-guide	9aea3e2a86ff0f3e51532038c83266ed0b2653e8	Nitro Js API Integration guide		f	t	\N			## **Nitro JavaScript API Integration Documentation**\n\nThis guide provides information on how to use Nitro's JavaScript API to identify visitors and track various events on your website.\n\n\n\n### Table of Contents\n\n1. Visitor Identification\n2. Events Tracking\n2.1. View Event\n2.2. Update Cart Event\n2.3. Checkout Event\n2.4. Buy Event\n2.5. Product View Event\n2.6. Category View Event\n2.7. Custom Events\n2.8. High Intent Users\n\n\n\n### 1.\tVisitor Identification \nUse **nitro.identify** method to identify visitors by providing their email, phone, and name.\n```js\nnitro.identify("<visitor_email>", "<visitor_phone>", "<visitor_name>");\n\n```\n\n### 2. Events Tracking \nDifferent events can be tracked with the help of methods enlisted below:\n\n####  2.1. View Event \nUse **nitro.view** method to track page views.\n```js\n// Example view event data\nview_data = {\n    page: "https://someurl.com"\n}\n\n// Track view event\nnitro.view(view_data);\n\n```\n \n#### 2.2. Update Cart Event on add to cart\nUse **nitro.updatecart** method to track when items are added to the cart. line_items should contain item/items added to cart.\n- While sending cart event, only send the items which are added to/ removed from the cart and not the previously added/removed/already present items.\ne.g. : if item-1 is added to the cart, send the event updatecart with the details of item-1 in the line items.\nNow, if another item is added to the cart, lets say, item-2, then, send the event updatecart with the details of item-2 only in the line items. Please make sure to send the data of the item which has been added/removed and not any other item in the cart.\n```js\n// Example add to cart event data\ncart_data = {"line_items": line_items, "cart_value": cart_value}\ncart_data = {\n    cart_url: "https://someurl.com",\n    product_id: 123456,\n    line_items: [{\n      "quantity": 1,\n      "title": "Black Box",\n      "line_price", 24.00,\n      "id": "987654" (Variant Id),\n      "product_id": "1234567",\n      "image_url": "variant or product image url"\n    },\n    {\n      "quantity": 1,\n      "title": "Pink Box",\n      "line_price", 20.00,\n      "id": "987654" (Variant Id),\n      "product_id": "1234568",\n      "image_url": "variant or product image url"\n    }],\n  \tcart_value: 44.00\n}\n\n// Track add to cart event\nnitro.updatecart(cart_data);\n\n```\n \n#### 2.3. Remove From Cart Event \nUse **nitro.removefromcart** method to track when items are removed from the cart. line_items should contain item/items removed from cart\n- While sending cart event, only send the items which are added to/ removed from the cart and not the previously added/removed/already present items.\ne.g. : if item-1 is removed from the cart, send the event removefromcart with the details of item-1 in the line items.\nNow, if another item is removed from the cart, lets say, item-2, then, send the event removefromcart with the details of item-2 only in the line items. Please make sure to send the data of the item which has been added/removed and not any other item from the cart.\n```js\n// Example remove from cart event data\ncart_data = {"line_items": line_items, "cart_value": cart_value}\ncart_data = {\n    cart_url: "https://someurl.com",\n    product_id: 123456,\n    line_items: [{\n      "quantity": 1,\n      "title": "Black Box",\n      "line_price", 24.00,\n      "id": "987654" (Variant Id),\n      "product_id": "1234567",\n      "image_url": "variant or product image url"\n    }],\n  \tcart_value: 20.00\n}\n\n// Track add to cart event\nnitro.removefromcart(cart_data);\n\n```\n \n#### 2.4. Checkout Event \nUse **nitro.checkout** method to track checkout events. \n```js\n// Example checkout event data\ncheckout_data = {\n    checkout: "<checkout_url>",\n    items: [\n        {\n            product_id: 12345,\n            price: 12.00,\n            product_url: "https://someurl.com/product_id"\n        },\n\t\t\t\t{\n            product_id: 12346,\n            price: 18.00,\n            product_url: "https://someurl.com/product_id"\n        }\n    ],\n    cart_value: <total_checkout_amount>,\n}\n\n// Track checkout event\nnitro.checkout(checkout_data);\n\n```\n\n#### 2.5. Buy Event \nUse **nitro.buy** method to track purchase events.\n```js\n// Example buy event data\nbuy_data = {\n    checkout_url: "https://someurl.com",\n  \torder_id: "1231312312312",\n    items: [\n        {\n            product_id: 12345,\n            price: 12.00,\n            product_url: "https://someurl.com/product_id"\n        },\n        {\n            product_id: 12346,\n            price: 12.00,\n            product_url: "https://someurl.com/product_id"\n        }\n    ]\n}\n\n// Track buy event\nnitro.buy(buy_data);\n\n```\n \n#### 2.6. Product View Event \nUse **nitro.productView** method to track product view events.\n```js\n// Example product view event data\nproduct_data = {\n    product_id: 12345,\n    price: "12.00",\n    product_url: "https://someurl.com/product_id"\n}\n\n// Track product view event\nnitro.productView(product_data);\n\n```\n \n#### 2.7. Category View Event \nUse **nitro.categoryView** method to track category view events.\n```js\n// Example category view event data\ncategory_data = {\n    category: "fashion"\n}\n\n// Track category view event\nnitro.categoryView(category_data);\n\n```\n\n#### 2.8. Custom Events \nUse **nitro.track** method to track custom events.\n```js\n// Example custom event\nnitro.track("<EVENT_NAME>", EVENT_VALUE);\n\n```\n \n- Replace **<EVENT_NAME>** with the name of your custom event and **EVENT_VALUE** with the corresponding value.\n\n\n---\n\n#### 2.8. High Intent Users - \n\nEvents to enter funnel =  ["addtocart", "updatecart", "checkout"]\n\nEvents to exit funnel = "buy"\n	<h2 class="toc-header" id="nitro-javascript-api-integration-documentation"><a href="#nitro-javascript-api-integration-documentation" class="toc-anchor">¶</a> <strong>Nitro JavaScript API Integration Documentation</strong></h2>\n<p>This guide provides information on how to use Nitro's JavaScript API to identify visitors and track various events on your website.</p>\n<h3 class="toc-header" id="table-of-contents"><a href="#table-of-contents" class="toc-anchor">¶</a> Table of Contents</h3>\n<ol>\n<li>Visitor Identification</li>\n<li>Events Tracking<br>\n2.1. View Event<br>\n2.2. Update Cart Event<br>\n2.3. Checkout Event<br>\n2.4. Buy Event<br>\n2.5. Product View Event<br>\n2.6. Category View Event<br>\n2.7. Custom Events<br>\n2.8. High Intent Users</li>\n</ol>\n<h3 class="toc-header" id="h-1visitor-identification"><a href="#h-1visitor-identification" class="toc-anchor">¶</a> 1.\tVisitor Identification</h3>\n<p>Use <strong>nitro.identify</strong> method to identify visitors by providing their email, phone, and name.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">nitro.identify("&lt;visitor_email&gt;", "&lt;visitor_phone&gt;", "&lt;visitor_name&gt;");\n\n</code></pre>\n<h3 class="toc-header" id="h-2-events-tracking"><a href="#h-2-events-tracking" class="toc-anchor">¶</a> 2. Events Tracking</h3>\n<p>Different events can be tracked with the help of methods enlisted below:</p>\n<h4 class="toc-header" id="h-21-view-event"><a href="#h-21-view-event" class="toc-anchor">¶</a> 2.1. View Event</h4>\n<p>Use <strong>nitro.view</strong> method to track page views.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example view event data\nview_data = {\n    page: "https://someurl.com"\n}\n\n// Track view event\nnitro.view(view_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-22-update-cart-event-on-add-to-cart"><a href="#h-22-update-cart-event-on-add-to-cart" class="toc-anchor">¶</a> 2.2. Update Cart Event on add to cart</h4>\n<p>Use <strong>nitro.updatecart</strong> method to track when items are added to the cart. line_items should contain item/items added to cart.</p>\n<ul>\n<li>While sending cart event, only send the items which are added to/ removed from the cart and not the previously added/removed/already present items.<br>\ne.g. : if item-1 is added to the cart, send the event updatecart with the details of item-1 in the line items.<br>\nNow, if another item is added to the cart, lets say, item-2, then, send the event updatecart with the details of item-2 only in the line items. Please make sure to send the data of the item which has been added/removed and not any other item in the cart.</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example add to cart event data\ncart_data = {"line_items": line_items, "cart_value": cart_value}\ncart_data = {\n    cart_url: "https://someurl.com",\n    product_id: 123456,\n    line_items: [{\n      "quantity": 1,\n      "title": "Black Box",\n      "line_price", 24.00,\n      "id": "987654" (Variant Id),\n      "product_id": "1234567",\n      "image_url": "variant or product image url"\n    },\n    {\n      "quantity": 1,\n      "title": "Pink Box",\n      "line_price", 20.00,\n      "id": "987654" (Variant Id),\n      "product_id": "1234568",\n      "image_url": "variant or product image url"\n    }],\n  \tcart_value: 44.00\n}\n\n// Track add to cart event\nnitro.updatecart(cart_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-23-remove-from-cart-event"><a href="#h-23-remove-from-cart-event" class="toc-anchor">¶</a> 2.3. Remove From Cart Event</h4>\n<p>Use <strong>nitro.removefromcart</strong> method to track when items are removed from the cart. line_items should contain item/items removed from cart</p>\n<ul>\n<li>While sending cart event, only send the items which are added to/ removed from the cart and not the previously added/removed/already present items.<br>\ne.g. : if item-1 is removed from the cart, send the event removefromcart with the details of item-1 in the line items.<br>\nNow, if another item is removed from the cart, lets say, item-2, then, send the event removefromcart with the details of item-2 only in the line items. Please make sure to send the data of the item which has been added/removed and not any other item from the cart.</li>\n</ul>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example remove from cart event data\ncart_data = {"line_items": line_items, "cart_value": cart_value}\ncart_data = {\n    cart_url: "https://someurl.com",\n    product_id: 123456,\n    line_items: [{\n      "quantity": 1,\n      "title": "Black Box",\n      "line_price", 24.00,\n      "id": "987654" (Variant Id),\n      "product_id": "1234567",\n      "image_url": "variant or product image url"\n    }],\n  \tcart_value: 20.00\n}\n\n// Track add to cart event\nnitro.removefromcart(cart_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-24-checkout-event"><a href="#h-24-checkout-event" class="toc-anchor">¶</a> 2.4. Checkout Event</h4>\n<p>Use <strong>nitro.checkout</strong> method to track checkout events.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example checkout event data\ncheckout_data = {\n    checkout: "&lt;checkout_url&gt;",\n    items: [\n        {\n            product_id: 12345,\n            price: 12.00,\n            product_url: "https://someurl.com/product_id"\n        },\n                {\n            product_id: 12346,\n            price: 18.00,\n            product_url: "https://someurl.com/product_id"\n        }\n    ],\n    cart_value: &lt;total_checkout_amount&gt;,\n}\n\n// Track checkout event\nnitro.checkout(checkout_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-25-buy-event"><a href="#h-25-buy-event" class="toc-anchor">¶</a> 2.5. Buy Event</h4>\n<p>Use <strong>nitro.buy</strong> method to track purchase events.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example buy event data\nbuy_data = {\n    checkout_url: "https://someurl.com",\n  \torder_id: "1231312312312",\n    items: [\n        {\n            product_id: 12345,\n            price: 12.00,\n            product_url: "https://someurl.com/product_id"\n        },\n        {\n            product_id: 12346,\n            price: 12.00,\n            product_url: "https://someurl.com/product_id"\n        }\n    ]\n}\n\n// Track buy event\nnitro.buy(buy_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-26-product-view-event"><a href="#h-26-product-view-event" class="toc-anchor">¶</a> 2.6. Product View Event</h4>\n<p>Use <strong>nitro.productView</strong> method to track product view events.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example product view event data\nproduct_data = {\n    product_id: 12345,\n    price: "12.00",\n    product_url: "https://someurl.com/product_id"\n}\n\n// Track product view event\nnitro.productView(product_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-27-category-view-event"><a href="#h-27-category-view-event" class="toc-anchor">¶</a> 2.7. Category View Event</h4>\n<p>Use <strong>nitro.categoryView</strong> method to track category view events.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example category view event data\ncategory_data = {\n    category: "fashion"\n}\n\n// Track category view event\nnitro.categoryView(category_data);\n\n</code></pre>\n<h4 class="toc-header" id="h-28-custom-events"><a href="#h-28-custom-events" class="toc-anchor">¶</a> 2.8. Custom Events</h4>\n<p>Use <strong>nitro.track</strong> method to track custom events.</p>\n<pre v-pre="true" class="prismjs line-numbers"><code class="language-js">// Example custom event\nnitro.track("&lt;EVENT_NAME&gt;", EVENT_VALUE);\n\n</code></pre>\n<ul>\n<li>Replace <strong>&lt;EVENT_NAME&gt;</strong> with the name of your custom event and <strong>EVENT_VALUE</strong> with the corresponding value.</li>\n</ul>\n<hr>\n<h4 class="toc-header" id="h-28-high-intent-users-"><a href="#h-28-high-intent-users-" class="toc-anchor">¶</a> 2.8. High Intent Users -</h4>\n<p>Events to enter funnel =  ["addtocart", "updatecart", "checkout"]</p>\n<p>Events to exit funnel = "buy"</p>\n	[{"title":"Nitro JavaScript API Integration Documentation","anchor":"#nitro-javascript-api-integration-documentation","children":[{"title":"Table of Contents","anchor":"#table-of-contents","children":[]},{"title":"1.\\tVisitor Identification","anchor":"#h-1visitor-identification","children":[]},{"title":"2. Events Tracking","anchor":"#h-2-events-tracking","children":[{"title":"2.1. View Event","anchor":"#h-21-view-event","children":[]},{"title":"2.2. Update Cart Event on add to cart","anchor":"#h-22-update-cart-event-on-add-to-cart","children":[]},{"title":"2.3. Remove From Cart Event","anchor":"#h-23-remove-from-cart-event","children":[]},{"title":"2.4. Checkout Event","anchor":"#h-24-checkout-event","children":[]},{"title":"2.5. Buy Event","anchor":"#h-25-buy-event","children":[]},{"title":"2.6. Product View Event","anchor":"#h-26-product-view-event","children":[]},{"title":"2.7. Category View Event","anchor":"#h-27-category-view-event","children":[]},{"title":"2.8. Custom Events","anchor":"#h-28-custom-events","children":[]},{"title":"2.8. High Intent Users -","anchor":"#h-28-high-intent-users-","children":[]}]}]}]	markdown	2024-01-24T10:36:27.610Z	2024-09-11T09:21:07.204Z	markdown	en	7	1	{"js":"","css":""}
15	nitrox-user-guide	594e4933e5400a560ccb142994572d07aa1ad7c3	NitroX User Guide	This document consists a detailed understanding of NitroX	f	t	\N			<h1>NitroX - User Guide</h1>\n<p>&nbsp;</p>\n<p><strong>Overview:</strong></p>\n<p>In today’s e-commerce landscape, businesses face significant challenges such as rising <strong>Customer Acquisition Costs</strong> (CAC), <strong>poor Return on Ad Spend</strong> (ROAS), and the <strong>repetitive cycle</strong> of targeting the same customer pool. Perhaps most critically, up to <strong>99% of website visitors</strong> remain <strong>anonymous</strong>, making it difficult to convert traffic into actual sales.</p>\n<p><strong>NitroX</strong> is a cutting-edge Revenue as a Service (RaaS) platform designed to address these challenges head-on. Leveraging a decade of innovation and patent-pending identification technology, NitroX transforms anonymous website visitors into identifiable shoppers, enabling e-commerce businesses to capture and convert more of their traffic.</p>\n<p>&nbsp;</p>\n<p><strong>Platform Features:&nbsp;</strong></p>\n<p>NitroX is packed with powerful features that help e-commerce businesses unlock the full potential of their website traffic.</p>\n<p>1.<strong> Live Activity Monitoring:</strong> Get real-time insights into customer behavior, enabling swift adjustments to your marketing strategies</p>\n<figure class="image"><img src="/live.png"></figure>\n<p>2. <strong>Contacts:</strong> Build and update a robust customer database with daily refreshed, consented user contact information</p>\n<figure class="image"><img src="/contacts_.png"></figure>\n<p>3. <a href="https://docs.nitrocommerce.ai/e/en/consent-management"><strong>Consent Management:</strong></a> Automatically pre-fill contact info for identified visitors, streamlining consent management and activity tracking</p>\n<figure class="image"><img src="/cms.png"></figure>\n<p>4. <a href="https://docs.nitrocommerce.ai/en/high-intent-users"><strong>High-Intent Users:</strong></a> Identify and target visitors most likely to convert, boosting conversion rates and ROAS with personalized strategies</p>\n<figure class="image"><img src="/hiu_overview.png"></figure>\n<p>5. <strong>Forever Links:</strong> Redirect users from in-app browsers to their default browser for a fully optimized website experience, increasing engagement and conversions</p>\n<figure class="image"><img src="/forever_link.png"></figure>\n<p>6. <strong>Integrations:</strong> Connect NitroX to any CRM platform, utilizing identified user data to automate personalized communication and enhance customer engagement</p>\n<figure class="image"><img src="/integrations.png"></figure>\n<p>&nbsp;</p>\n<p><strong>Core Concepts:</strong></p>\n<ol>\n  <li><strong>Maximising lead generation at Top-of-the-Funnel (ToFu):</strong>\n    <ul>\n      <li><strong>Converting Anonymous Traffic:</strong> NitroX transforms anonymous visitors into identified leads, reducing acquisition costs and strengthening your Top-of-the-Funnel (ToFu) efforts</li>\n      <li><strong>Enhancing Campaign Effectiveness:</strong> The Forever Links feature improves user experience, reduces bounce rates, and drives more qualified traffic, boosting social media campaign success</li>\n    </ul>\n  </li>\n  <li><strong>Streamlining conversions at Middle-of-the-Funnel (MoFu):</strong>\n    <ul>\n      <li><strong>Simplifying User journeys:</strong> NitroX’s pre-filled Consent Management pop-ups reduce friction, pushing users through the Middle-of-the-Funnel (MoFu) and turning interest into intent</li>\n      <li><strong>Prioritizing High potential leads:</strong> By identifying high-intent users, NitroX focuses your efforts on those most likely to convert, increasing ROI and minimizing user drop-off</li>\n    </ul>\n  </li>\n  <li><strong>Real-time Optimisation across the Funnel:</strong>\n    <ul>\n      <li><strong>Immediate Behavioural Insights:</strong> NitroX offers real-time monitoring, enabling instant responses to user behavior and optimizing marketing efforts throughout the funnel</li>\n      <li><strong>Consistent Data Enrichment:</strong> Daily updates of user data enrich your first-party database, supporting targeted and effective campaigns</li>\n    </ul>\n  </li>\n  <li><strong>Building a Data-driven Strategy:</strong>\n    <ul>\n      <li><strong>Leveraging First-party data: </strong>NitroX collects authentic first-party data, enabling personalized marketing and higher conversion rates while ensuring compliance with data privacy regulations</li>\n      <li><strong>Ensuring Compliance:</strong> NitroX’s fingerprinting approach provides transparent data enrichment, fully compliant with the Digital Personal Data Protection (DPDP) Act of 2023</li>\n    </ul>\n  </li>\n</ol>\n<p>&nbsp;</p>\n<p><strong>Getting Started:</strong></p>\n<p>The best way to get started with NitroX is by following our <a href="https://docs.nitrocommerce.ai/e/en/quick-start-guide">Quick Start Guide</a>. This guide will walk you through the essentials in just a few steps:</p>\n<p>1. <strong>Create Your Account</strong>: Sign up and activate your NitroX account.</p>\n<p>2. <strong>Integrate with Your Website</strong>: If your website is built on Shopify you can install the app directly or you can add the NitroX tracking code to your website.</p>\n<p>3. <strong>Configure Key Features</strong>: Set up Consent Management, High-Intent Users, Forever Links, Live Activity Monitoring, and Contacts Management.</p>\n<p>4. <strong>Start Monitoring and Optimizing</strong>: Begin exploring user data and adjusting your strategies to maximize performance.</p>\n<p>&nbsp;</p>\n	<h1 class="toc-header" id="nitrox-user-guide"><a href="#nitrox-user-guide" class="toc-anchor">¶</a> NitroX - User Guide</h1>\n<p>&nbsp;</p>\n<p><strong>Overview:</strong></p>\n<p>In today’s e-commerce landscape, businesses face significant challenges such as rising <strong>Customer Acquisition Costs</strong> (CAC), <strong>poor Return on Ad Spend</strong> (ROAS), and the <strong>repetitive cycle</strong> of targeting the same customer pool. Perhaps most critically, up to <strong>99% of website visitors</strong> remain <strong>anonymous</strong>, making it difficult to convert traffic into actual sales.</p>\n<p><strong>NitroX</strong> is a cutting-edge Revenue as a Service (RaaS) platform designed to address these challenges head-on. Leveraging a decade of innovation and patent-pending identification technology, NitroX transforms anonymous website visitors into identifiable shoppers, enabling e-commerce businesses to capture and convert more of their traffic.</p>\n<p>&nbsp;</p>\n<p><strong>Platform Features:&nbsp;</strong></p>\n<p>NitroX is packed with powerful features that help e-commerce businesses unlock the full potential of their website traffic.</p>\n<p>1.<strong> Live Activity Monitoring:</strong> Get real-time insights into customer behavior, enabling swift adjustments to your marketing strategies</p>\n<figure class="image"><img src="/live.png"></figure>\n<p>2. <strong>Contacts:</strong> Build and update a robust customer database with daily refreshed, consented user contact information</p>\n<figure class="image"><img src="/contacts_.png"></figure>\n<p>3. <a class="is-system-link" href="/e/en/consent-management"><strong>Consent Management:</strong></a> Automatically pre-fill contact info for identified visitors, streamlining consent management and activity tracking</p>\n<figure class="image"><img src="/cms.png"></figure>\n<p>4. <a class="is-internal-link is-valid-page" href="/en/high-intent-users"><strong>High-Intent Users:</strong></a> Identify and target visitors most likely to convert, boosting conversion rates and ROAS with personalized strategies</p>\n<figure class="image"><img src="/hiu_overview.png"></figure>\n<p>5. <strong>Forever Links:</strong> Redirect users from in-app browsers to their default browser for a fully optimized website experience, increasing engagement and conversions</p>\n<figure class="image"><img src="/forever_link.png"></figure>\n<p>6. <strong>Integrations:</strong> Connect NitroX to any CRM platform, utilizing identified user data to automate personalized communication and enhance customer engagement</p>\n<figure class="image"><img src="/integrations.png"></figure>\n<p>&nbsp;</p>\n<p><strong>Core Concepts:</strong></p>\n<ol>\n  <li><strong>Maximising lead generation at Top-of-the-Funnel (ToFu):</strong>\n    <ul>\n      <li><strong>Converting Anonymous Traffic:</strong> NitroX transforms anonymous visitors into identified leads, reducing acquisition costs and strengthening your Top-of-the-Funnel (ToFu) efforts</li>\n      <li><strong>Enhancing Campaign Effectiveness:</strong> The Forever Links feature improves user experience, reduces bounce rates, and drives more qualified traffic, boosting social media campaign success</li>\n    </ul>\n  </li>\n  <li><strong>Streamlining conversions at Middle-of-the-Funnel (MoFu):</strong>\n    <ul>\n      <li><strong>Simplifying User journeys:</strong> NitroX’s pre-filled Consent Management pop-ups reduce friction, pushing users through the Middle-of-the-Funnel (MoFu) and turning interest into intent</li>\n      <li><strong>Prioritizing High potential leads:</strong> By identifying high-intent users, NitroX focuses your efforts on those most likely to convert, increasing ROI and minimizing user drop-off</li>\n    </ul>\n  </li>\n  <li><strong>Real-time Optimisation across the Funnel:</strong>\n    <ul>\n      <li><strong>Immediate Behavioural Insights:</strong> NitroX offers real-time monitoring, enabling instant responses to user behavior and optimizing marketing efforts throughout the funnel</li>\n      <li><strong>Consistent Data Enrichment:</strong> Daily updates of user data enrich your first-party database, supporting targeted and effective campaigns</li>\n    </ul>\n  </li>\n  <li><strong>Building a Data-driven Strategy:</strong>\n    <ul>\n      <li><strong>Leveraging First-party data: </strong>NitroX collects authentic first-party data, enabling personalized marketing and higher conversion rates while ensuring compliance with data privacy regulations</li>\n      <li><strong>Ensuring Compliance:</strong> NitroX’s fingerprinting approach provides transparent data enrichment, fully compliant with the Digital Personal Data Protection (DPDP) Act of 2023</li>\n    </ul>\n  </li>\n</ol>\n<p>&nbsp;</p>\n<p><strong>Getting Started:</strong></p>\n<p>The best way to get started with NitroX is by following our <a class="is-system-link" href="/e/en/quick-start-guide">Quick Start Guide</a>. This guide will walk you through the essentials in just a few steps:</p>\n<p>1. <strong>Create Your Account</strong>: Sign up and activate your NitroX account.</p>\n<p>2. <strong>Integrate with Your Website</strong>: If your website is built on Shopify you can install the app directly or you can add the NitroX tracking code to your website.</p>\n<p>3. <strong>Configure Key Features</strong>: Set up Consent Management, High-Intent Users, Forever Links, Live Activity Monitoring, and Contacts Management.</p>\n<p>4. <strong>Start Monitoring and Optimizing</strong>: Begin exploring user data and adjusting your strategies to maximize performance.</p>\n<p>&nbsp;</p>\n	[{"title":"NitroX - User Guide","anchor":"#nitrox-user-guide","children":[]}]	html	2024-09-02T12:39:17.444Z	2024-09-09T11:20:36.317Z	ckeditor	en	10	10	{"js":"","css":""}
18	high-intent-users	b28ba3d2d0f8f9d41adaec8beca881ffd5e151e5	High Intent Users	This document describes High-Intent Users as a feature in detail	f	t	\N			<h1>NitroX - High Intent Users</h1>\n<p><strong>Overview:</strong></p>\n<p>The High Intent Users feature in NitroX is designed to identify and target visitors who exhibit a high likelihood of making a purchase. By analyzing a range of user behaviors and attributes, this feature helps e-commerce businesses focus their marketing efforts on the most promising leads, resulting in improved conversion rates and return on ad spend (ROAS)</p>\n<figure class="image"><img src="/hiu_section.png"></figure>\n<p>&nbsp;</p>\n<p>&nbsp;</p>\n	<h1 class="toc-header" id="nitrox-high-intent-users"><a href="#nitrox-high-intent-users" class="toc-anchor">¶</a> NitroX - High Intent Users</h1>\n<p><strong>Overview:</strong></p>\n<p>The High Intent Users feature in NitroX is designed to identify and target visitors who exhibit a high likelihood of making a purchase. By analyzing a range of user behaviors and attributes, this feature helps e-commerce businesses focus their marketing efforts on the most promising leads, resulting in improved conversion rates and return on ad spend (ROAS)</p>\n<figure class="image"><img src="/hiu_section.png"></figure>\n<p>&nbsp;</p>\n<p>&nbsp;</p>\n	[{"title":"NitroX - High Intent Users","anchor":"#nitrox-high-intent-users","children":[]}]	html	2024-09-09T11:19:31.487Z	2024-09-16T14:30:59.078Z	ckeditor	en	10	10	{"js":"","css":""}
19	nitroxregressionchecklist	a4a751cc4b9608f9eaebb96565f212e44f807fe5	Blackbox Regression Checklist		f	t	\N			## NitroX Blackbox Regression Checklist:\n\n### Login Flow at NitroX\n1. Login page https://x.nitrocommerce.ai/login should be reachable.\n2. User should be able to login at the existing account.\n3. New user should be able to register as well and then login as well.\n\n### Reset Password Flow\n1. Forget password link at Login page should be reachable.\n2. User should receive reset password link at the entered email id.\n3. Reset password link should be reachable and user should be able to reset the password and login at https://x.nitrocommerce.ai/login .\n\n### Installing SuperAcquire\n1. Go to the admin panel of a new shopify store and view "settings".\n2. Select "Apps and sales channels" and go to "Shopify App Store".\n3. Search and install SuperAcquire -> User should be redirected to Nitro dashboard https://x.nitrocommerce.ai/dashboard.\n\n### Re-installing SuperAcquire\n1. Go to the admin panel of your exisiting shopify store which is already connected to SuperAcquire and view "settings".\n2. Select "Apps and sales channels" and go to "Shopify App Store".\n3. Select "unistall" option beside the SuperAcquire app -> SuperAcquire should get unistalled from the store.\n4. Select "Unistalled" section under "apps and sales channel".\n5. Install SuperAcquire app again -> User should be redirected to Nitro dashboard https://x.nitrocommerce.ai/dashboard.\n\n### Opening SuperAcquire from Shopify\n1. Go to the admin panel of your exisiting shopify store which is already connected to SuperAcquire and view "settings".\n2. Visit "Apps and sales channels"and select "SuperAcquire".\n3. Select on SuperAcquire under installed apps -> click on "Open App" -> User should be redirected to Nitro dashboard https://x.nitrocommerce.ai/dashboard .\n\n### Dashboard Flow\n1. Visit https://x.nitrocommerce.ai/dashboard -> Dashboard page should be reachable.\n2. Organisation dropdown list should be accessable.\n3. Numbers at dashboard widgets should get populated.\n\n### Live Activity Flow\n1. Page view, Category view, Product view, Addtocart, Removedfromcart and Checkout events should get populated under user live actviti for SuperAcquire.\n2. User details should get populated in case of identified user.\n\n### Discount Coupon Prefill Flow\n1. Select Discount coupon from the Consent Management tab.\n2. Discount coupon should get populated at the store.\n3. Visibility of div with id "nitroPopUpIframeContainer" should be "visible".\n4. For identified user, phone number should come prefilled in the popup.\n\n### Forever Links Flow\n1. Select Forever Links tab on NitroX/SuperAcquire dashboard\n2. Click on create link -> forever link for specified URL should get created.\n3. On clicking bin icon against the link, it should get deleted from the list.\n4. On clicking the link, destination URL should open up in default browser window.\n\n\n### Webhook Integration Flow\n1. Go to Webhook Integration under the Platform section from the Integrations tab.\n2. Enter the endpoint and select data type to be exported at webhook.\n3. For Events data type, view, product view, category view, addtocart, removedfromcart and checkout events should get exported at the endpoint, for an identified user.\n4. For Contacts data type, user email and phone should get exported at the endpoint, for an identified user.\n5. Click on Add Webhook -> new webhook should get added and user should be able to save and update it as well.\n6. On clicking Remove button, the given webhook should get deleted.\n\n\n### Contacts Flow\n1. Contacts page should be reachable and download contacts list should get populated on the page.\n2. Click on download phone/emails -> user email modal should open up.\n3. Link to contacts CSV should be emailed at the entered email id.\n4. User contacts should be available in the downloaded CSV file.\n\n\n### High Intent Users Flow\n1. High Intent Users(HIU) page should be reachable.\n2. Users abandoning carts/checkouts should get populated under HIU list after 4hrs.\n3. All identified users should get populated under the All Identified Users list.\n4. User should be able to download HIU contacts and all identified contacts via email.\n4. Masked PIN Code should be avaible for the users under user details.\n	<h2 class="toc-header" id="nitrox-blackbox-regression-checklist"><a href="#nitrox-blackbox-regression-checklist" class="toc-anchor">¶</a> NitroX Blackbox Regression Checklist:</h2>\n<h3 class="toc-header" id="login-flow-at-nitrox"><a href="#login-flow-at-nitrox" class="toc-anchor">¶</a> Login Flow at NitroX</h3>\n<ol>\n<li>Login page <a class="is-external-link" href="https://x.nitrocommerce.ai/login">https://x.nitrocommerce.ai/login</a> should be reachable.</li>\n<li>User should be able to login at the existing account.</li>\n<li>New user should be able to register as well and then login as well.</li>\n</ol>\n<h3 class="toc-header" id="reset-password-flow"><a href="#reset-password-flow" class="toc-anchor">¶</a> Reset Password Flow</h3>\n<ol>\n<li>Forget password link at Login page should be reachable.</li>\n<li>User should receive reset password link at the entered email id.</li>\n<li>Reset password link should be reachable and user should be able to reset the password and login at <a class="is-external-link" href="https://x.nitrocommerce.ai/login">https://x.nitrocommerce.ai/login</a> .</li>\n</ol>\n<h3 class="toc-header" id="installing-superacquire"><a href="#installing-superacquire" class="toc-anchor">¶</a> Installing SuperAcquire</h3>\n<ol>\n<li>Go to the admin panel of a new shopify store and view "settings".</li>\n<li>Select "Apps and sales channels" and go to "Shopify App Store".</li>\n<li>Search and install SuperAcquire -&gt; User should be redirected to Nitro dashboard <a class="is-external-link" href="https://x.nitrocommerce.ai/dashboard">https://x.nitrocommerce.ai/dashboard</a>.</li>\n</ol>\n<h3 class="toc-header" id="re-installing-superacquire"><a href="#re-installing-superacquire" class="toc-anchor">¶</a> Re-installing SuperAcquire</h3>\n<ol>\n<li>Go to the admin panel of your exisiting shopify store which is already connected to SuperAcquire and view "settings".</li>\n<li>Select "Apps and sales channels" and go to "Shopify App Store".</li>\n<li>Select "unistall" option beside the SuperAcquire app -&gt; SuperAcquire should get unistalled from the store.</li>\n<li>Select "Unistalled" section under "apps and sales channel".</li>\n<li>Install SuperAcquire app again -&gt; User should be redirected to Nitro dashboard <a class="is-external-link" href="https://x.nitrocommerce.ai/dashboard">https://x.nitrocommerce.ai/dashboard</a>.</li>\n</ol>\n<h3 class="toc-header" id="opening-superacquire-from-shopify"><a href="#opening-superacquire-from-shopify" class="toc-anchor">¶</a> Opening SuperAcquire from Shopify</h3>\n<ol>\n<li>Go to the admin panel of your exisiting shopify store which is already connected to SuperAcquire and view "settings".</li>\n<li>Visit "Apps and sales channels"and select "SuperAcquire".</li>\n<li>Select on SuperAcquire under installed apps -&gt; click on "Open App" -&gt; User should be redirected to Nitro dashboard <a class="is-external-link" href="https://x.nitrocommerce.ai/dashboard">https://x.nitrocommerce.ai/dashboard</a> .</li>\n</ol>\n<h3 class="toc-header" id="dashboard-flow"><a href="#dashboard-flow" class="toc-anchor">¶</a> Dashboard Flow</h3>\n<ol>\n<li>Visit <a class="is-external-link" href="https://x.nitrocommerce.ai/dashboard">https://x.nitrocommerce.ai/dashboard</a> -&gt; Dashboard page should be reachable.</li>\n<li>Organisation dropdown list should be accessable.</li>\n<li>Numbers at dashboard widgets should get populated.</li>\n</ol>\n<h3 class="toc-header" id="live-activity-flow"><a href="#live-activity-flow" class="toc-anchor">¶</a> Live Activity Flow</h3>\n<ol>\n<li>Page view, Category view, Product view, Addtocart, Removedfromcart and Checkout events should get populated under user live actviti for SuperAcquire.</li>\n<li>User details should get populated in case of identified user.</li>\n</ol>\n<h3 class="toc-header" id="discount-coupon-prefill-flow"><a href="#discount-coupon-prefill-flow" class="toc-anchor">¶</a> Discount Coupon Prefill Flow</h3>\n<ol>\n<li>Select Discount coupon from the Consent Management tab.</li>\n<li>Discount coupon should get populated at the store.</li>\n<li>Visibility of div with id "nitroPopUpIframeContainer" should be "visible".</li>\n<li>For identified user, phone number should come prefilled in the popup.</li>\n</ol>\n<h3 class="toc-header" id="forever-links-flow"><a href="#forever-links-flow" class="toc-anchor">¶</a> Forever Links Flow</h3>\n<ol>\n<li>Select Forever Links tab on NitroX/SuperAcquire dashboard</li>\n<li>Click on create link -&gt; forever link for specified URL should get created.</li>\n<li>On clicking bin icon against the link, it should get deleted from the list.</li>\n<li>On clicking the link, destination URL should open up in default browser window.</li>\n</ol>\n<h3 class="toc-header" id="webhook-integration-flow"><a href="#webhook-integration-flow" class="toc-anchor">¶</a> Webhook Integration Flow</h3>\n<ol>\n<li>Go to Webhook Integration under the Platform section from the Integrations tab.</li>\n<li>Enter the endpoint and select data type to be exported at webhook.</li>\n<li>For Events data type, view, product view, category view, addtocart, removedfromcart and checkout events should get exported at the endpoint, for an identified user.</li>\n<li>For Contacts data type, user email and phone should get exported at the endpoint, for an identified user.</li>\n<li>Click on Add Webhook -&gt; new webhook should get added and user should be able to save and update it as well.</li>\n<li>On clicking Remove button, the given webhook should get deleted.</li>\n</ol>\n<h3 class="toc-header" id="contacts-flow"><a href="#contacts-flow" class="toc-anchor">¶</a> Contacts Flow</h3>\n<ol>\n<li>Contacts page should be reachable and download contacts list should get populated on the page.</li>\n<li>Click on download phone/emails -&gt; user email modal should open up.</li>\n<li>Link to contacts CSV should be emailed at the entered email id.</li>\n<li>User contacts should be available in the downloaded CSV file.</li>\n</ol>\n<h3 class="toc-header" id="high-intent-users-flow"><a href="#high-intent-users-flow" class="toc-anchor">¶</a> High Intent Users Flow</h3>\n<ol>\n<li>High Intent Users(HIU) page should be reachable.</li>\n<li>Users abandoning carts/checkouts should get populated under HIU list after 4hrs.</li>\n<li>All identified users should get populated under the All Identified Users list.</li>\n<li>User should be able to download HIU contacts and all identified contacts via email.</li>\n<li>Masked PIN Code should be avaible for the users under user details.</li>\n</ol>\n	[{"title":"NitroX Blackbox Regression Checklist:","anchor":"#nitrox-blackbox-regression-checklist","children":[{"title":"Login Flow at NitroX","anchor":"#login-flow-at-nitrox","children":[]},{"title":"Reset Password Flow","anchor":"#reset-password-flow","children":[]},{"title":"Installing SuperAcquire","anchor":"#installing-superacquire","children":[]},{"title":"Re-installing SuperAcquire","anchor":"#re-installing-superacquire","children":[]},{"title":"Opening SuperAcquire from Shopify","anchor":"#opening-superacquire-from-shopify","children":[]},{"title":"Dashboard Flow","anchor":"#dashboard-flow","children":[]},{"title":"Live Activity Flow","anchor":"#live-activity-flow","children":[]},{"title":"Discount Coupon Prefill Flow","anchor":"#discount-coupon-prefill-flow","children":[]},{"title":"Forever Links Flow","anchor":"#forever-links-flow","children":[]},{"title":"Webhook Integration Flow","anchor":"#webhook-integration-flow","children":[]},{"title":"Contacts Flow","anchor":"#contacts-flow","children":[]},{"title":"High Intent Users Flow","anchor":"#high-intent-users-flow","children":[]}]}]	markdown	2024-09-23T08:22:05.236Z	2024-09-27T05:59:22.143Z	markdown	en	3	3	{"js":"","css":""}
20	ssoregressionchecklist	33a1a60d35281ac320694d425d7c502827ad73e4	SSO Regression Checklist		f	t	\N			# SSO Regression Checklist\n\n### Registeration Flow\n1. Visit https://storefront.nitrocommerce.ai -> it should redirect to https://sso.nitrocommerce.ai for user login.\n2. New user should be able to register at SSO. \n3. Email verification at SSO should only happen once, for a new user.\n\n### Login Flow\n1. Visit https://storefront.nitrocommerce.ai -> it should redirect to https://sso.nitrocommerce.ai for user login.\n2. Existing user should be able to login with the existing password or with NitroX password if same user has an account on NitroX as well.\n3. An error message should be displayed to the user if wrong emial/password is submitted.\n4. No email verification should happen again for an existing verified user.\n\n### Forget Password Flow\n1. 1. Visit https://storefront.nitrocommerce.ai -> it should redirect to https://sso.nitrocommerce.ai for user login.\n2. Click on forget password at SSO login page -> enter your email to get reset password link.\n5. An error message should be displayed to the user if wromg email is submitted.\n3. Reset password link should be sent to the registered user email.\n4. User should be able to reset the password and login at https://storefront.nitrocommerce.ai with the new password.\n	<h1 class="toc-header" id="sso-regression-checklist"><a href="#sso-regression-checklist" class="toc-anchor">¶</a> SSO Regression Checklist</h1>\n<h3 class="toc-header" id="registeration-flow"><a href="#registeration-flow" class="toc-anchor">¶</a> Registeration Flow</h3>\n<ol>\n<li>Visit <a class="is-external-link" href="https://storefront.nitrocommerce.ai">https://storefront.nitrocommerce.ai</a> -&gt; it should redirect to <a class="is-external-link" href="https://sso.nitrocommerce.ai">https://sso.nitrocommerce.ai</a> for user login.</li>\n<li>New user should be able to register at SSO.</li>\n<li>Email verification at SSO should only happen once, for a new user.</li>\n</ol>\n<h3 class="toc-header" id="login-flow"><a href="#login-flow" class="toc-anchor">¶</a> Login Flow</h3>\n<ol>\n<li>Visit <a class="is-external-link" href="https://storefront.nitrocommerce.ai">https://storefront.nitrocommerce.ai</a> -&gt; it should redirect to <a class="is-external-link" href="https://sso.nitrocommerce.ai">https://sso.nitrocommerce.ai</a> for user login.</li>\n<li>Existing user should be able to login with the existing password or with NitroX password if same user has an account on NitroX as well.</li>\n<li>An error message should be displayed to the user if wrong emial/password is submitted.</li>\n<li>No email verification should happen again for an existing verified user.</li>\n</ol>\n<h3 class="toc-header" id="forget-password-flow"><a href="#forget-password-flow" class="toc-anchor">¶</a> Forget Password Flow</h3>\n<ol>\n<li>\n<ol>\n<li>Visit <a class="is-external-link" href="https://storefront.nitrocommerce.ai">https://storefront.nitrocommerce.ai</a> -&gt; it should redirect to <a class="is-external-link" href="https://sso.nitrocommerce.ai">https://sso.nitrocommerce.ai</a> for user login.</li>\n</ol>\n</li>\n<li>Click on forget password at SSO login page -&gt; enter your email to get reset password link.</li>\n<li>An error message should be displayed to the user if wromg email is submitted.</li>\n<li>Reset password link should be sent to the registered user email.</li>\n<li>User should be able to reset the password and login at <a class="is-external-link" href="https://storefront.nitrocommerce.ai">https://storefront.nitrocommerce.ai</a> with the new password.</li>\n</ol>\n	[{"title":"SSO Regression Checklist","anchor":"#sso-regression-checklist","children":[]}]	markdown	2024-09-27T05:34:05.848Z	2024-09-27T05:38:48.697Z	markdown	en	3	3	{"js":"","css":""}
22	event-schemas	844cb0b50ff63afc02a2e7906007902b59f4a831	NitroX Event Schemas		f	t	\N			## Event Schemas based on User Activity\n\n### 1. Page View \n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "view",\n  "eventVal": {\n    "page": "https://store.myshopify.com/",\n    "h": "store.myshopify.com",\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "https://store.myshopify.com/",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:36:49.048055+00:00"\n}\n\n\n**Data type:**\n- customer - map\n- page - string\n- h - string  \n\n\n\n---\n\n\n\n  \n### 2. Category View\n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "category_view",\n  "eventVal": {\n    "page": "https://store.myshopify.com/collections/all",\n    "resource_id": null,\n    "resource": null,\n    "domain": "store.myshopify.com",\n    "h": "store.myshopify.com",\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "https://store.myshopify.com/collections/all",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:37:09.970422+00:00"\n}\n\n**Data Type:**\n- customer - map\n- domain -string\n- h - string\n- page - string\n\n\n\n---\n\n\n### 3. Product View\n{\n  "org_token": "97a9933c-d2aa-4018-9fcf-f59b2c4938f2",\n  "eventName": "product_view",\n  "eventVal": {\n    "page": "https://quickstart-6afbfc31.myshopify.com/products/the-multi-managed-snowboard",\n    "resource_id": 8213254668437,\n    "resource": "product",\n    "domain": "quickstart-6afbfc31.myshopify.com",\n    "price": 629.95,\n    "h": "quickstart-6afbfc31.myshopify.com",\n    "image": "https://cdn.shopify.com/s/files/1/0654/5866/7669/products/Main_9129b69a-0c7b-4f66-b6cf-c4222f18028a.jpg?v=1710241840",\n    "title": "The Multi-managed Snowboard",\n    "customer": {\n      "email": null,\n      "phone": "+911234512345",\n      "name": null\n    }\n  },\n  "u": "https://quickstart-6afbfc31.myshopify.com/products/the-multi-managed-snowboard",\n  "lang": "en",\n  "userId": "af2c5603-ac36-4722-b795-b9809a78a29b",\n  "timestamp": "2024-11-08T07:03:26.477800+00:00"\n}\n\n\n**Data Type:**\n- customer - map\n- domain - string\n- h - string\n- image - string\n- page - string\n- resource - string\n- resource_id - number\n- title - string\n\n\n\n---\n\n\n### 4. Add To Cart\n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "addtocart",\n  "eventVal": {\n    "line_items": [\n      {\n        "quantity": 1,\n        "title": "The Collection Snowboard: Hydrogen",\n        "line_price": "600.00",\n        "id": 45471438340248,\n        "product_id": 8498999558296,\n        "image_url": "https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260"\n      }\n    ],\n    "cart_value": 600,\n    "recent_product_image": "https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260",\n    "init_cart": false,\n    "empty_cart": false,\n    "items_added": [\n      {\n        "quantity": 1,\n        "title": "The Collection Snowboard: Hydrogen",\n        "line_price": "600.00",\n        "id": 45471438340248,\n        "product_id": 8498999558296,\n        "image_url": "https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260"\n      }\n    ],\n    "items_removed": [],\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:30:35.858469+00:00"\n}\n\n**Data Type:**\n- cart_value - number\n- customer - map\n- empty_cart - boolean\n- init_cart - boolean\n- items_added - array\n- items_removed - array\n- line_items - array\n- recent_product_image - string\n\n\n\n---\n\n\n### 5. Checkout\n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "checkout",\n  "eventVal": {\n    "checkout": "https://store.myshopify.com/67312648344/checkouts/ac/Z2NwLWFzaWEtc291dGhlYXN0MTowMUo5SzhUR0dQWlhINFBQS0szRjFUS0tXRg/recover?key=c1f5094475e89c2b566ad99cda25102f&amp;locale=en-IN",\n    "cart_value": "600.00",\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:31:53.597232+00:00"\n}\n\n**Data Type:**\n- cart_value - string\n- checkout - string\n- customer - map\n\n\n\n---\n\n\n### 6. Order Updated\n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "orders-updated",\n  "eventVal": {\n    "url": "https://store.myshopify.com/67312648344/orders/7c63fe52d7f27866462aeb39bcbe0cb3/authenticate?key=a3b7a6f0c9b70015e8dc8f19445e7e8e",\n    "order_id": 1005,\n    "price": "600.00",\n    "currency": "INR",\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:35:28.646894+00:00"\n}\n\n**Data Type:**\n- currency - string\n- customer - map\n- order_id - number\n- price - string\n- url - string\n\n\n---\n\n\n\n### 7. Order Created\n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "orders-create",\n  "eventVal": {\n    "url": "https://store.myshopify.com/67312648344/orders/7c63fe52d7f27866462aeb39bcbe0cb3/authenticate?key=a3b7a6f0c9b70015e8dc8f19445e7e8e",\n    "order_id": 1005,\n    "price": "600.00",\n    "currency": "INR",\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:35:29.495421+00:00"\n}\n\n**Data Type:**\n- currency - string\n- customer - map\n- order_id - number\n- price - string\n- url - string\n\n\n\n---\n\n\n### 8. Remove from Cart \n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "removefromcart",\n  "eventVal": {\n    "line_items": [],\n    "cart_value": 0,\n    "recent_product_image": null,\n    "init_cart": false,\n    "empty_cart": true,\n    "items_added": [],\n    "items_removed": [\n      {\n        "quantity": 2,\n        "title": "The 3p Fulfilled Snowboard",\n        "line_price": "5259.90",\n        "id": 45471438667928,\n        "product_id": 8498999853208,\n        "image_url": "https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_b9e0da7f-db89-4d41-83f0-7f417b02831d.jpg?v=1727439260"\n      }\n    ],\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:38:47.337793+00:00"\n}\n\n**Data Type:**\n- cart_value - number\n- customer - map\n- empty_cart - boolean\n- init_cart - boolean\n- items_added - array\n- items_removed - array\n- line_items - array\n- recent_product_image - string\n\n\n\n---\n\n---\n\n\n## Event Schemas based on Consent Management\n\n\n### 1. Consent Given\n{\n  "org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "eventName": "is_consented",\n  "eventVal": {\n    "phone": "+911234567890",\n    "h": "store.myshopify.com",\n    "customer": {\n      "email": "email@gmail.co",\n      "phone": "+911234567890",\n      "name": "Test User"\n    }\n  },\n  "u": "",\n  "lang": "en",\n  "userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:49:13.378909+00:00"\n}\n\n**Data Type:**\n- customer - map\n- h - string\n- phone - string\n\n\n\n---\n\n### 2. OTP Verified\n{\n  "contact": "email@gmail.co",\n  "type": "EMAIL",\n  "date": "2024-10-08",\n  "org_id": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",\n  "name": "Test User",\n  "nitro_id": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",\n  "timestamp": "2024-10-08T06:52:25.839935+00:00",\n  "identified_by": "third_party"\n}\n\n**Data Type:**\n- customer - map\n- h - string\n- phone - string\n\n\n\n---\n\n\n	<h2 class="toc-header" id="event-schemas-based-on-user-activity"><a href="#event-schemas-based-on-user-activity" class="toc-anchor">¶</a> Event Schemas based on User Activity</h2>\n<h3 class="toc-header" id="h-1-page-view"><a href="#h-1-page-view" class="toc-anchor">¶</a> 1. Page View</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "view",<br>\n"eventVal": {<br>\n"page": "<a class="is-external-link" href="https://store.myshopify.com/">https://store.myshopify.com/</a>",<br>\n"h": "<a class="is-external-link" href="http://store.myshopify.com">store.myshopify.com</a>",<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "<a class="is-external-link" href="https://store.myshopify.com/">https://store.myshopify.com/</a>",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:36:49.048055+00:00"<br>\n}</p>\n<p><strong>Data type:</strong></p>\n<ul>\n<li>customer - map</li>\n<li>page - string</li>\n<li>h - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-2-category-view"><a href="#h-2-category-view" class="toc-anchor">¶</a> 2. Category View</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "category_view",<br>\n"eventVal": {<br>\n"page": "<a class="is-external-link" href="https://store.myshopify.com/collections/all">https://store.myshopify.com/collections/all</a>",<br>\n"resource_id": null,<br>\n"resource": null,<br>\n"domain": "<a class="is-external-link" href="http://store.myshopify.com">store.myshopify.com</a>",<br>\n"h": "<a class="is-external-link" href="http://store.myshopify.com">store.myshopify.com</a>",<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "<a class="is-external-link" href="https://store.myshopify.com/collections/all">https://store.myshopify.com/collections/all</a>",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:37:09.970422+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>customer - map</li>\n<li>domain -string</li>\n<li>h - string</li>\n<li>page - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-3-product-view"><a href="#h-3-product-view" class="toc-anchor">¶</a> 3. Product View</h3>\n<p>{<br>\n"org_token": "97a9933c-d2aa-4018-9fcf-f59b2c4938f2",<br>\n"eventName": "product_view",<br>\n"eventVal": {<br>\n"page": "<a class="is-external-link" href="https://quickstart-6afbfc31.myshopify.com/products/the-multi-managed-snowboard">https://quickstart-6afbfc31.myshopify.com/products/the-multi-managed-snowboard</a>",<br>\n"resource_id": 8213254668437,<br>\n"resource": "product",<br>\n"domain": "<a class="is-external-link" href="http://quickstart-6afbfc31.myshopify.com">quickstart-6afbfc31.myshopify.com</a>",<br>\n"price": 629.95,<br>\n"h": "<a class="is-external-link" href="http://quickstart-6afbfc31.myshopify.com">quickstart-6afbfc31.myshopify.com</a>",<br>\n"image": "<a class="is-external-link" href="https://cdn.shopify.com/s/files/1/0654/5866/7669/products/Main_9129b69a-0c7b-4f66-b6cf-c4222f18028a.jpg?v=1710241840">https://cdn.shopify.com/s/files/1/0654/5866/7669/products/Main_9129b69a-0c7b-4f66-b6cf-c4222f18028a.jpg?v=1710241840</a>",<br>\n"title": "The Multi-managed Snowboard",<br>\n"customer": {<br>\n"email": null,<br>\n"phone": "+911234512345",<br>\n"name": null<br>\n}<br>\n},<br>\n"u": "<a class="is-external-link" href="https://quickstart-6afbfc31.myshopify.com/products/the-multi-managed-snowboard">https://quickstart-6afbfc31.myshopify.com/products/the-multi-managed-snowboard</a>",<br>\n"lang": "en",<br>\n"userId": "af2c5603-ac36-4722-b795-b9809a78a29b",<br>\n"timestamp": "2024-11-08T07:03:26.477800+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>customer - map</li>\n<li>domain - string</li>\n<li>h - string</li>\n<li>image - string</li>\n<li>page - string</li>\n<li>resource - string</li>\n<li>resource_id - number</li>\n<li>title - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-4-add-to-cart"><a href="#h-4-add-to-cart" class="toc-anchor">¶</a> 4. Add To Cart</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "addtocart",<br>\n"eventVal": {<br>\n"line_items": [<br>\n{<br>\n"quantity": 1,<br>\n"title": "The Collection Snowboard: Hydrogen",<br>\n"line_price": "600.00",<br>\n"id": 45471438340248,<br>\n"product_id": 8498999558296,<br>\n"image_url": "<a class="is-external-link" href="https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260">https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260</a>"<br>\n}<br>\n],<br>\n"cart_value": 600,<br>\n"recent_product_image": "<a class="is-external-link" href="https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260">https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260</a>",<br>\n"init_cart": false,<br>\n"empty_cart": false,<br>\n"items_added": [<br>\n{<br>\n"quantity": 1,<br>\n"title": "The Collection Snowboard: Hydrogen",<br>\n"line_price": "600.00",<br>\n"id": 45471438340248,<br>\n"product_id": 8498999558296,<br>\n"image_url": "<a class="is-external-link" href="https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260">https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_0a40b01b-5021-48c1-80d1-aa8ab4876d3d.jpg?v=1727439260</a>"<br>\n}<br>\n],<br>\n"items_removed": [],<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:30:35.858469+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>cart_value - number</li>\n<li>customer - map</li>\n<li>empty_cart - boolean</li>\n<li>init_cart - boolean</li>\n<li>items_added - array</li>\n<li>items_removed - array</li>\n<li>line_items - array</li>\n<li>recent_product_image - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-5-checkout"><a href="#h-5-checkout" class="toc-anchor">¶</a> 5. Checkout</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "checkout",<br>\n"eventVal": {<br>\n"checkout": "<a class="is-external-link" href="https://store.myshopify.com/67312648344/checkouts/ac/Z2NwLWFzaWEtc291dGhlYXN0MTowMUo5SzhUR0dQWlhINFBQS0szRjFUS0tXRg/recover?key=c1f5094475e89c2b566ad99cda25102f&amp;locale=en-IN">https://store.myshopify.com/67312648344/checkouts/ac/Z2NwLWFzaWEtc291dGhlYXN0MTowMUo5SzhUR0dQWlhINFBQS0szRjFUS0tXRg/recover?key=c1f5094475e89c2b566ad99cda25102f&amp;locale=en-IN</a>",<br>\n"cart_value": "600.00",<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:31:53.597232+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>cart_value - string</li>\n<li>checkout - string</li>\n<li>customer - map</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-6-order-updated"><a href="#h-6-order-updated" class="toc-anchor">¶</a> 6. Order Updated</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "orders-updated",<br>\n"eventVal": {<br>\n"url": "<a class="is-external-link" href="https://store.myshopify.com/67312648344/orders/7c63fe52d7f27866462aeb39bcbe0cb3/authenticate?key=a3b7a6f0c9b70015e8dc8f19445e7e8e">https://store.myshopify.com/67312648344/orders/7c63fe52d7f27866462aeb39bcbe0cb3/authenticate?key=a3b7a6f0c9b70015e8dc8f19445e7e8e</a>",<br>\n"order_id": 1005,<br>\n"price": "600.00",<br>\n"currency": "INR",<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:35:28.646894+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>currency - string</li>\n<li>customer - map</li>\n<li>order_id - number</li>\n<li>price - string</li>\n<li>url - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-7-order-created"><a href="#h-7-order-created" class="toc-anchor">¶</a> 7. Order Created</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "orders-create",<br>\n"eventVal": {<br>\n"url": "<a class="is-external-link" href="https://store.myshopify.com/67312648344/orders/7c63fe52d7f27866462aeb39bcbe0cb3/authenticate?key=a3b7a6f0c9b70015e8dc8f19445e7e8e">https://store.myshopify.com/67312648344/orders/7c63fe52d7f27866462aeb39bcbe0cb3/authenticate?key=a3b7a6f0c9b70015e8dc8f19445e7e8e</a>",<br>\n"order_id": 1005,<br>\n"price": "600.00",<br>\n"currency": "INR",<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:35:29.495421+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>currency - string</li>\n<li>customer - map</li>\n<li>order_id - number</li>\n<li>price - string</li>\n<li>url - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-8-remove-from-cart"><a href="#h-8-remove-from-cart" class="toc-anchor">¶</a> 8. Remove from Cart</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "removefromcart",<br>\n"eventVal": {<br>\n"line_items": [],<br>\n"cart_value": 0,<br>\n"recent_product_image": null,<br>\n"init_cart": false,<br>\n"empty_cart": true,<br>\n"items_added": [],<br>\n"items_removed": [<br>\n{<br>\n"quantity": 2,<br>\n"title": "The 3p Fulfilled Snowboard",<br>\n"line_price": "5259.90",<br>\n"id": 45471438667928,<br>\n"product_id": 8498999853208,<br>\n"image_url": "<a class="is-external-link" href="https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_b9e0da7f-db89-4d41-83f0-7f417b02831d.jpg?v=1727439260">https://cdn.shopify.com/s/files/1/0673/1264/8344/files/Main_b9e0da7f-db89-4d41-83f0-7f417b02831d.jpg?v=1727439260</a>"<br>\n}<br>\n],<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:38:47.337793+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>cart_value - number</li>\n<li>customer - map</li>\n<li>empty_cart - boolean</li>\n<li>init_cart - boolean</li>\n<li>items_added - array</li>\n<li>items_removed - array</li>\n<li>line_items - array</li>\n<li>recent_product_image - string</li>\n</ul>\n<hr>\n<hr>\n<h2 class="toc-header" id="event-schemas-based-on-consent-management"><a href="#event-schemas-based-on-consent-management" class="toc-anchor">¶</a> Event Schemas based on Consent Management</h2>\n<h3 class="toc-header" id="h-1-consent-given"><a href="#h-1-consent-given" class="toc-anchor">¶</a> 1. Consent Given</h3>\n<p>{<br>\n"org_token": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"eventName": "is_consented",<br>\n"eventVal": {<br>\n"phone": "+911234567890",<br>\n"h": "<a class="is-external-link" href="http://store.myshopify.com">store.myshopify.com</a>",<br>\n"customer": {<br>\n"email": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"phone": "+911234567890",<br>\n"name": "Test User"<br>\n}<br>\n},<br>\n"u": "",<br>\n"lang": "en",<br>\n"userId": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:49:13.378909+00:00"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>customer - map</li>\n<li>h - string</li>\n<li>phone - string</li>\n</ul>\n<hr>\n<h3 class="toc-header" id="h-2-otp-verified"><a href="#h-2-otp-verified" class="toc-anchor">¶</a> 2. OTP Verified</h3>\n<p>{<br>\n"contact": "<a href="mailto:email@gmail.co">email@gmail.co</a>",<br>\n"type": "EMAIL",<br>\n"date": "2024-10-08",<br>\n"org_id": "b4656a84-f7ee-4ef0-a7cc-408cd7ba6584",<br>\n"name": "Test User",<br>\n"nitro_id": "218f7fef-56e0-4a1c-81ad-ff84c6377e22",<br>\n"timestamp": "2024-10-08T06:52:25.839935+00:00",<br>\n"identified_by": "third_party"<br>\n}</p>\n<p><strong>Data Type:</strong></p>\n<ul>\n<li>customer - map</li>\n<li>h - string</li>\n<li>phone - string</li>\n</ul>\n<hr>\n	[{"title":"Event Schemas based on User Activity","anchor":"#event-schemas-based-on-user-activity","children":[{"title":"1. Page View","anchor":"#h-1-page-view","children":[]},{"title":"2. Category View","anchor":"#h-2-category-view","children":[]},{"title":"3. Product View","anchor":"#h-3-product-view","children":[]},{"title":"4. Add To Cart","anchor":"#h-4-add-to-cart","children":[]},{"title":"5. Checkout","anchor":"#h-5-checkout","children":[]},{"title":"6. Order Updated","anchor":"#h-6-order-updated","children":[]},{"title":"7. Order Created","anchor":"#h-7-order-created","children":[]},{"title":"8. Remove from Cart","anchor":"#h-8-remove-from-cart","children":[]}]},{"title":"Event Schemas based on Consent Management","anchor":"#event-schemas-based-on-consent-management","children":[{"title":"1. Consent Given","anchor":"#h-1-consent-given","children":[]},{"title":"2. OTP Verified","anchor":"#h-2-otp-verified","children":[]}]}]	markdown	2024-10-08T07:12:03.774Z	2025-01-06T12:43:05.361Z	markdown	en	3	13	{"js":"","css":""}
3	shopify-custom-app	0cb71d6affcb24554d7417085a628501b3683aeb	Shopify Custom App Installation Guide		f	t	\N			# Integrate with Shopify (Custom App)\n\nYou can integrate your Nitro account directly with the Shopify Custom App.\nAn integration between Nitro and a Shopify Custom App automatically installs our scripts.\n\n\n\n## What you'll need\n\n1. Your Shopify Store URL and Access Token. \nFind your Shopify Store URL under Stores option from the left menu bar.\n\n![ss1.jpg](/ss1.jpg)\n\n2. To find/create your Access Token, go to Settings > Apps and sales channels > Click on Develop apps.\n\n![ss2.jpg](/ss2.jpg)\n\n3. Click on Allow Custom App Development and Create an app (if one doesn't exist).\n\n![ss3.jpg](/ss3.jpg)\n\n![ss4bb.jpg](/ss4bb.jpg)\n\n![ss5b.jpg](/ss5b.jpg)\n\n4. Name your app and click Create app.\n\n![ss6c.jpg](/ss6c.jpg)\n\n5. Now click on Configure Admin API scopes > select Configure Admin API Integration option under the Configuration tab.\n\n![ss7.jpg](/ss7.jpg)\n\n![ss8.jpg](/ss8.jpg)\n\n6. Search for "order" in the search bar and set all the orders permissions.\n\n![ss9.jpg](/ss9.jpg)\n\n![oo1.jpg](/oo1.jpg)\n\n7. Search for "cart" in the search bar, and set all these permissions.\n\n![oo2.jpg](/oo2.jpg)\n\n8. Search for "customer" in the search bar, and set all these permissions.\n\n![image_(168).png](/image_(168).png)\n\n9. Search for "product" in the search bar, and set all these permissions.\n\n![image_(169).png](/image_(169).png) \n\n10. Search for "checkout" in the search bar, and set all these permissions.\n\n![oo3.jpg](/oo3.jpg)\n\n11. Click Install App > Install.\n\n![ss10.jpg](/ss10.jpg)\n\n12. Click Reveal token once and copy the Access Token. Remember: This token can only be viewed/copied once, so be sure to save it somewhere safe.\n\n![ss11.jpg](/ss11.jpg)\n\n\n## Integrating with Nitro\n\n1. Visit x.getnitro.co and login into your account. Then, click on the Install tab from the left menu bar. Select Shopify Integration option.\n\n![image_new.jpg](/screenshots/image_new.jpg)\n\n2. Enter your Shopify Store name under the shop section as mentioned in the placeholder. Also enter the Access Token which you saved earlier.\n\n3. To enable the integration click Save.\n\n4. Once the integration is complete, you will start receiving user live activity events for the shopify store.\n\n\n\n## Removing the Integration\n\n\n1. From your Shopify store, go to Settings > Apps and sales channels > Develop apps.\n\n![re1.jpg](/re1.jpg)\n\n![re2.jpg](/re2.jpg)\n\n2. Click on the app you created for the integration.\n\n![re3b.jpg](/re3b.jpg)\n\n3. Click Uninstall app.\n\n![re4.jpg](/re4.jpg)\n\n4. Then, click Uninstall.\n\n![re5.jpg](/re5.jpg)\n\n\n---\n\n\n***Note: If you currently have Nitro script on your domain, you will need to remove this before setting up the custom integration.***\n	<h1 class="toc-header" id="integrate-with-shopify-custom-app"><a href="#integrate-with-shopify-custom-app" class="toc-anchor">¶</a> Integrate with Shopify (Custom App)</h1>\n<p>You can integrate your Nitro account directly with the Shopify Custom App.<br>\nAn integration between Nitro and a Shopify Custom App automatically installs our scripts.</p>\n<h2 class="toc-header" id="what-youll-need"><a href="#what-youll-need" class="toc-anchor">¶</a> What you'll need</h2>\n<ol>\n<li>Your Shopify Store URL and Access Token.<br>\nFind your Shopify Store URL under Stores option from the left menu bar.</li>\n</ol>\n<p><img alt="ss1.jpg" src="/ss1.jpg"></p>\n<ol start="2">\n<li>To find/create your Access Token, go to Settings &gt; Apps and sales channels &gt; Click on Develop apps.</li>\n</ol>\n<p><img alt="ss2.jpg" src="/ss2.jpg"></p>\n<ol start="3">\n<li>Click on Allow Custom App Development and Create an app (if one doesn't exist).</li>\n</ol>\n<p><img alt="ss3.jpg" src="/ss3.jpg"></p>\n<p><img alt="ss4bb.jpg" src="/ss4bb.jpg"></p>\n<p><img alt="ss5b.jpg" src="/ss5b.jpg"></p>\n<ol start="4">\n<li>Name your app and click Create app.</li>\n</ol>\n<p><img alt="ss6c.jpg" src="/ss6c.jpg"></p>\n<ol start="5">\n<li>Now click on Configure Admin API scopes &gt; select Configure Admin API Integration option under the Configuration tab.</li>\n</ol>\n<p><img alt="ss7.jpg" src="/ss7.jpg"></p>\n<p><img alt="ss8.jpg" src="/ss8.jpg"></p>\n<ol start="6">\n<li>Search for "order" in the search bar and set all the orders permissions.</li>\n</ol>\n<p><img alt="ss9.jpg" src="/ss9.jpg"></p>\n<p><img alt="oo1.jpg" src="/oo1.jpg"></p>\n<ol start="7">\n<li>Search for "cart" in the search bar, and set all these permissions.</li>\n</ol>\n<p><img alt="oo2.jpg" src="/oo2.jpg"></p>\n<ol start="8">\n<li>Search for "customer" in the search bar, and set all these permissions.</li>\n</ol>\n<p><img alt="image_(168).png" src="/image_(168).png"></p>\n<ol start="9">\n<li>Search for "product" in the search bar, and set all these permissions.</li>\n</ol>\n<p><img alt="image_(169).png" src="/image_(169).png"></p>\n<ol start="10">\n<li>Search for "checkout" in the search bar, and set all these permissions.</li>\n</ol>\n<p><img alt="oo3.jpg" src="/oo3.jpg"></p>\n<ol start="11">\n<li>Click Install App &gt; Install.</li>\n</ol>\n<p><img alt="ss10.jpg" src="/ss10.jpg"></p>\n<ol start="12">\n<li>Click Reveal token once and copy the Access Token. Remember: This token can only be viewed/copied once, so be sure to save it somewhere safe.</li>\n</ol>\n<p><img alt="ss11.jpg" src="/ss11.jpg"></p>\n<h2 class="toc-header" id="integrating-with-nitro"><a href="#integrating-with-nitro" class="toc-anchor">¶</a> Integrating with Nitro</h2>\n<ol>\n<li>Visit <a class="is-external-link" href="http://x.getnitro.co">x.getnitro.co</a> and login into your account. Then, click on the Install tab from the left menu bar. Select Shopify Integration option.</li>\n</ol>\n<p><img alt="image_new.jpg" src="/screenshots/image_new.jpg"></p>\n<ol start="2">\n<li>\n<p>Enter your Shopify Store name under the shop section as mentioned in the placeholder. Also enter the Access Token which you saved earlier.</p>\n</li>\n<li>\n<p>To enable the integration click Save.</p>\n</li>\n<li>\n<p>Once the integration is complete, you will start receiving user live activity events for the shopify store.</p>\n</li>\n</ol>\n<h2 class="toc-header" id="removing-the-integration"><a href="#removing-the-integration" class="toc-anchor">¶</a> Removing the Integration</h2>\n<ol>\n<li>From your Shopify store, go to Settings &gt; Apps and sales channels &gt; Develop apps.</li>\n</ol>\n<p><img alt="re1.jpg" src="/re1.jpg"></p>\n<p><img alt="re2.jpg" src="/re2.jpg"></p>\n<ol start="2">\n<li>Click on the app you created for the integration.</li>\n</ol>\n<p><img alt="re3b.jpg" src="/re3b.jpg"></p>\n<ol start="3">\n<li>Click Uninstall app.</li>\n</ol>\n<p><img alt="re4.jpg" src="/re4.jpg"></p>\n<ol start="4">\n<li>Then, click Uninstall.</li>\n</ol>\n<p><img alt="re5.jpg" src="/re5.jpg"></p>\n<hr>\n<p><em><strong>Note: If you currently have Nitro script on your domain, you will need to remove this before setting up the custom integration.</strong></em></p>\n	[{"title":"Integrate with Shopify (Custom App)","anchor":"#integrate-with-shopify-custom-app","children":[{"title":"What you'll need","anchor":"#what-youll-need","children":[]},{"title":"Integrating with Nitro","anchor":"#integrating-with-nitro","children":[]},{"title":"Removing the Integration","anchor":"#removing-the-integration","children":[]}]}]	markdown	2024-01-25T11:30:12.926Z	2024-12-24T07:28:55.239Z	markdown	en	3	3	{"js":"","css":""}
14	disable-shopify-captcha	4f73c17fd1c22d5e7ceb5d101c8514171c85100b	Disable Shopify Captcha		f	t	\N			# Deactivate hCAPTCHA on online store\nGoogle hCAPTCHA helps analyze the behavior of visitors to your online store to block spam from bots. Google hCAPTCHA also reduces friction for real users by eliminating captcha challenges and is enabled by default on all Shopify stores.\n\nGoogle hCAPTCHA can appear in the following locations of your online store:\n- in contact and comment forms\n- on login, create account, and password recovery pages \n\n### Following are the steps to deactivate/activate hcaptcha\n1. From your Shopify admin, go to **Online Store** > **Preferences**.\n![screenshot_from_2024-08-29_13-13-15.png](/screenshot_from_2024-08-29_13-13-15.png)\n\n2. In the **Spam protection** section, uncheck **Enable hCaptcha on login, create account and password recovery pages.**.\n![screenshot_from_2024-08-29_13-18-27.png](/screenshot_from_2024-08-29_13-18-27.png)\n\n3. Click Save.	<h1 class="toc-header" id="deactivate-hcaptcha-on-online-store"><a href="#deactivate-hcaptcha-on-online-store" class="toc-anchor">¶</a> Deactivate hCAPTCHA on online store</h1>\n<p>Google hCAPTCHA helps analyze the behavior of visitors to your online store to block spam from bots. Google hCAPTCHA also reduces friction for real users by eliminating captcha challenges and is enabled by default on all Shopify stores.</p>\n<p>Google hCAPTCHA can appear in the following locations of your online store:</p>\n<ul>\n<li>in contact and comment forms</li>\n<li>on login, create account, and password recovery pages</li>\n</ul>\n<h3 class="toc-header" id="following-are-the-steps-to-deactivateactivate-hcaptcha"><a href="#following-are-the-steps-to-deactivateactivate-hcaptcha" class="toc-anchor">¶</a> Following are the steps to deactivate/activate hcaptcha</h3>\n<ol>\n<li>\n<p>From your Shopify admin, go to <strong>Online Store</strong> &gt; <strong>Preferences</strong>.<br>\n<img alt="screenshot_from_2024-08-29_13-13-15.png" src="/screenshot_from_2024-08-29_13-13-15.png"></p>\n</li>\n<li>\n<p>In the <strong>Spam protection</strong> section, uncheck <strong>Enable hCaptcha on login, create account and password recovery pages.</strong>.<br>\n<img alt="screenshot_from_2024-08-29_13-18-27.png" src="/screenshot_from_2024-08-29_13-18-27.png"></p>\n</li>\n<li>\n<p>Click Save.</p>\n</li>\n</ol>\n	[{"title":"Deactivate hCAPTCHA on online store","anchor":"#deactivate-hcaptcha-on-online-store","children":[]}]	markdown	2024-08-29T07:35:18.696Z	2024-11-20T10:46:05.233Z	markdown	en	3	9	{"js":"","css":""}
23	nitro-zoho-integration	7c6b83bf4ae401ed138a877df6eaac10c3b9fe76	Nitro<>Zoho Integration Guide		f	t	\N			# Nitro<>Zoho Integration Guide\n\n### What you'll need \n1. Client ID\n2. Client Secret\n3. Generated Code\n4. Layout ID\n\n\n---\n\n\n### Steps to get Layout ID\n\n1. Visit https://crm.zoho.in and go to the home tab on your zoho dashboard. \n\tNow click on Setup option present in the top right corner.\n\n![zoho1.jpg](/zoho1.jpg)\n\n2. On the Setup page, click on "Modules and Fields" under the Customization menu.\n\n![zoho2.jpg](/zoho2.jpg)\n\n3. Now go to modules tab and click on Leads option. \n\tSelect Layout option under the leads menu.\n\n![zoho3.jpg](/zoho3.jpg)\n\n4. Leads page will open up. Now choose a layout for your Nitro leads.\n\t(leads from Nitro will appear on your Zoho dashboard in the selected layout format)\n\n![zoho4.jpg](/zoho4.jpg)\n\n5. After you select the leads layout, the selected layout page will open up. \n\tNow select and copy the layout ID present in the current page URL as shown.\n\n![zoho5.jpg](/zoho5.jpg)\n\n\n---\n\n\n### Steps to get Client ID and Client Secret\n\n1. Go to https://api-console.zoho.in and click on Get Started.\n\n![zoho11.jpg](/zoho11.jpg)\n\n\n2. Select Self Client under choose Client Type and click on Create.\n\n![zoho_12.jpg](/zoho_12.jpg)\n\n\n3. Copy the Client ID and Client Secret from the Client Secret tab.\n![zoho_13.jpg](/zoho_13.jpg)\n\n\n---\n\n\n### Steps to get Generated Code\n\n1. After getting the Client ID and Client Secret, click on Generated Code tab on the Self Client page.\n\tAdd "ZohoCRM.modules.ALL,ZohoCRM.settings.ALL" in the Scope input box.\n  \tChoose a time duration and add Scope description.\n    After adding scope details, click on Create.\n\n![zoho14.jpg](/zoho14.jpg)\n\n2. Now select "CRM" option under Select Portal section.\n\tFurther, select your org under the "Production" section.\n\n![zoho15.jpg](/zoho15.jpg)\n\n3. \tGenerated code dialogue box will appear. Copy this generated code.\n\n![zoho16.jpg](/zoho16.jpg)\n\n\n---\n\n\n### Integrating at Nitro\n\n1. Login at https://x.nitrocommerce.ai and go to the Integrations tab. Now go to "Connect with Zoho" under the Platforms section.\n\n2. Click on "Connect with Zoho". \n\tNow paste the Client ID, Client Secret, Generated Code and Layout ID which was obtained earlier.\n  \tSelect "ZOHO_INDIA" under the Zoho Domain dropdown and Click on save.\n    You will see a toast notification upon successful integration.\n\t\n![zoho18.jpg](/zoho18.jpg)\n\n\n\n\n\n\n\n	<h1 class="toc-header" id="nitrozoho-integration-guide"><a href="#nitrozoho-integration-guide" class="toc-anchor">¶</a> Nitro&lt;&gt;Zoho Integration Guide</h1>\n<h3 class="toc-header" id="what-youll-need"><a href="#what-youll-need" class="toc-anchor">¶</a> What you'll need</h3>\n<ol>\n<li>Client ID</li>\n<li>Client Secret</li>\n<li>Generated Code</li>\n<li>Layout ID</li>\n</ol>\n<hr>\n<h3 class="toc-header" id="steps-to-get-layout-id"><a href="#steps-to-get-layout-id" class="toc-anchor">¶</a> Steps to get Layout ID</h3>\n<ol>\n<li>Visit <a class="is-external-link" href="https://crm.zoho.in">https://crm.zoho.in</a> and go to the home tab on your zoho dashboard.<br>\nNow click on Setup option present in the top right corner.</li>\n</ol>\n<p><img alt="zoho1.jpg" src="/zoho1.jpg"></p>\n<ol start="2">\n<li>On the Setup page, click on "Modules and Fields" under the Customization menu.</li>\n</ol>\n<p><img alt="zoho2.jpg" src="/zoho2.jpg"></p>\n<ol start="3">\n<li>Now go to modules tab and click on Leads option.<br>\nSelect Layout option under the leads menu.</li>\n</ol>\n<p><img alt="zoho3.jpg" src="/zoho3.jpg"></p>\n<ol start="4">\n<li>Leads page will open up. Now choose a layout for your Nitro leads.<br>\n(leads from Nitro will appear on your Zoho dashboard in the selected layout format)</li>\n</ol>\n<p><img alt="zoho4.jpg" src="/zoho4.jpg"></p>\n<ol start="5">\n<li>After you select the leads layout, the selected layout page will open up.<br>\nNow select and copy the layout ID present in the current page URL as shown.</li>\n</ol>\n<p><img alt="zoho5.jpg" src="/zoho5.jpg"></p>\n<hr>\n<h3 class="toc-header" id="steps-to-get-client-id-and-client-secret"><a href="#steps-to-get-client-id-and-client-secret" class="toc-anchor">¶</a> Steps to get Client ID and Client Secret</h3>\n<ol>\n<li>Go to <a class="is-external-link" href="https://api-console.zoho.in">https://api-console.zoho.in</a> and click on Get Started.</li>\n</ol>\n<p><img alt="zoho11.jpg" src="/zoho11.jpg"></p>\n<ol start="2">\n<li>Select Self Client under choose Client Type and click on Create.</li>\n</ol>\n<p><img alt="zoho_12.jpg" src="/zoho_12.jpg"></p>\n<ol start="3">\n<li>Copy the Client ID and Client Secret from the Client Secret tab.<br>\n<img alt="zoho_13.jpg" src="/zoho_13.jpg"></li>\n</ol>\n<hr>\n<h3 class="toc-header" id="steps-to-get-generated-code"><a href="#steps-to-get-generated-code" class="toc-anchor">¶</a> Steps to get Generated Code</h3>\n<ol>\n<li>After getting the Client ID and Client Secret, click on Generated Code tab on the Self Client page.<br>\nAdd "ZohoCRM.modules.ALL,ZohoCRM.settings.ALL" in the Scope input box.<br>\nChoose a time duration and add Scope description.<br>\nAfter adding scope details, click on Create.</li>\n</ol>\n<p><img alt="zoho14.jpg" src="/zoho14.jpg"></p>\n<ol start="2">\n<li>Now select "CRM" option under Select Portal section.<br>\nFurther, select your org under the "Production" section.</li>\n</ol>\n<p><img alt="zoho15.jpg" src="/zoho15.jpg"></p>\n<ol start="3">\n<li>Generated code dialogue box will appear. Copy this generated code.</li>\n</ol>\n<p><img alt="zoho16.jpg" src="/zoho16.jpg"></p>\n<hr>\n<h3 class="toc-header" id="integrating-at-nitro"><a href="#integrating-at-nitro" class="toc-anchor">¶</a> Integrating at Nitro</h3>\n<ol>\n<li>\n<p>Login at <a class="is-external-link" href="https://x.nitrocommerce.ai">https://x.nitrocommerce.ai</a> and go to the Integrations tab. Now go to "Connect with Zoho" under the Platforms section.</p>\n</li>\n<li>\n<p>Click on "Connect with Zoho".<br>\nNow paste the Client ID, Client Secret, Generated Code and Layout ID which was obtained earlier.<br>\nSelect "ZOHO_INDIA" under the Zoho Domain dropdown and Click on save.<br>\nYou will see a toast notification upon successful integration.</p>\n</li>\n</ol>\n<p><img alt="zoho18.jpg" src="/zoho18.jpg"></p>\n	[{"title":"Nitro<>Zoho Integration Guide","anchor":"#nitrozoho-integration-guide","children":[]}]	markdown	2024-11-22T09:57:12.115Z	2024-11-27T07:41:33.855Z	markdown	en	3	3	{"js":"","css":""}
24	DPDP-Act	d45d245ac193e57fb4f01a7684b02095603614e8	DPDP Act		f	t	\N			![dpda_1_(1).png](/dpda_1_(1).png)\n\n![dpda_2_(1).png](/dpda_2_(1).png)\n\n![dpda_3_(1).png](/dpda_3_(1).png)\n\n![dpda_4_(1).png](/dpda_4_(1).png)\n\n![dpda_5_(1).png](/dpda_5_(1).png)	<p><img alt="dpda_1_(1).png" src="/dpda_1_(1).png"></p>\n<p><img alt="dpda_2_(1).png" src="/dpda_2_(1).png"></p>\n<p><img alt="dpda_3_(1).png" src="/dpda_3_(1).png"></p>\n<p><img alt="dpda_4_(1).png" src="/dpda_4_(1).png"></p>\n<p><img alt="dpda_5_(1).png" src="/dpda_5_(1).png"></p>\n	[]	markdown	2024-11-25T08:18:35.459Z	2024-11-25T08:21:23.001Z	markdown	en	3	3	{"js":"","css":""}
27	prefill-image-details	78be2175146325262fb1ea125949e26f519b64fa	Image Dimesions for Prefill Templates 		f	t	\N			# Image Dimentions for Prefill Templates\n\n### 1. Sign Up\n- Banner Image dimensions\n\t- Width: 450 pixels\n  -\tHeight: 550 pixels\n  \n- Brand Logo Image dimensions:\n\t- Width: 300 pixels\n  -\tHeight: 300 pixels\n\n\n### 2. Two Column Coupon\n- Image dimensions:\n\t- Width: 300 pixels\n  -\tHeight: 400 pixels\n\n\n### 3. Logo Discount Coupon\n- Banner Image dimensions:\n\t- Width: 340 pixels\n  -\tHeight: 400 pixels\n  \n- Logo Image dimensions:\n\t- Width: 200 pixels\n  -\tHeight: 70 pixels\n\n\n### 4. Card Coupon\n- Logo Image dimensions:\n\t- Width: 60 pixels\n  -\tHeight: 60 pixels\n  \n- Heading Image dimensions:\n\t- Width: 300 pixels\n  -\tHeight: 240 pixels\n  \n- Background Image dimensions:\n\t- Width: 300 pixels\n  -\tHeight: 420 pixels\n	<h1 class="toc-header" id="image-dimentions-for-prefill-templates"><a href="#image-dimentions-for-prefill-templates" class="toc-anchor">¶</a> Image Dimentions for Prefill Templates</h1>\n<h3 class="toc-header" id="h-1-sign-up"><a href="#h-1-sign-up" class="toc-anchor">¶</a> 1. Sign Up</h3>\n<ul>\n<li>\n<p>Banner Image dimensions</p>\n<ul>\n<li>Width: 450 pixels</li>\n<li>Height: 550 pixels</li>\n</ul>\n</li>\n<li>\n<p>Brand Logo Image dimensions:</p>\n<ul>\n<li>Width: 300 pixels</li>\n<li>Height: 300 pixels</li>\n</ul>\n</li>\n</ul>\n<h3 class="toc-header" id="h-2-two-column-coupon"><a href="#h-2-two-column-coupon" class="toc-anchor">¶</a> 2. Two Column Coupon</h3>\n<ul>\n<li>Image dimensions:\n<ul>\n<li>Width: 300 pixels</li>\n<li>Height: 400 pixels</li>\n</ul>\n</li>\n</ul>\n<h3 class="toc-header" id="h-3-logo-discount-coupon"><a href="#h-3-logo-discount-coupon" class="toc-anchor">¶</a> 3. Logo Discount Coupon</h3>\n<ul>\n<li>\n<p>Banner Image dimensions:</p>\n<ul>\n<li>Width: 340 pixels</li>\n<li>Height: 400 pixels</li>\n</ul>\n</li>\n<li>\n<p>Logo Image dimensions:</p>\n<ul>\n<li>Width: 200 pixels</li>\n<li>Height: 70 pixels</li>\n</ul>\n</li>\n</ul>\n<h3 class="toc-header" id="h-4-card-coupon"><a href="#h-4-card-coupon" class="toc-anchor">¶</a> 4. Card Coupon</h3>\n<ul>\n<li>\n<p>Logo Image dimensions:</p>\n<ul>\n<li>Width: 60 pixels</li>\n<li>Height: 60 pixels</li>\n</ul>\n</li>\n<li>\n<p>Heading Image dimensions:</p>\n<ul>\n<li>Width: 300 pixels</li>\n<li>Height: 240 pixels</li>\n</ul>\n</li>\n<li>\n<p>Background Image dimensions:</p>\n<ul>\n<li>Width: 300 pixels</li>\n<li>Height: 420 pixels</li>\n</ul>\n</li>\n</ul>\n	[{"title":"Image Dimentions for Prefill Templates","anchor":"#image-dimentions-for-prefill-templates","children":[]}]	markdown	2024-12-18T12:37:31.919Z	2024-12-23T13:12:19.885Z	markdown	en	3	3	{"js":"","css":""}
25	S2S-integration	9585d69efe72a99e845822df857244b0d82884af	Server-to-Server (S2S) Integration Guide		f	t	\N			# Server-to-Server (S2S) Integration Guide\n\n\n### What you'll need\n\n**To fetch data from Nitro Backend, you need the following IDs:**\n- token: `<ORGANISATION_TOKEN>`\n- parent: `<PARENT>`\n- nitro_id: `<NITRO_ID>`\n\n\n\n**These IDs are available fron nitro.js at the client side and can be fetched in 2 ways:**\n1. Using ready function in nitroSettings\n    Just like onIdentify function in nitroSettings, declare another function named ready. This function will be called once all the required IDs are loaded.\n    \nFor example, Your nitroSettings object should look something like:\n\n    window.nitro = {\n        events: {\n            onIdentify: function() {\n                // ...\n            }\n        },\n        ready: function(token, parent, nitro_id) {\n            // ...\n        }\n    },\n    \n    \n2. Using nitro.ready() function\n    nitro.ready function takes a function as a parameter, which is called once Nitro Script gets loaded.\n    \nFor example:\n\n    nitro.ready(function(token, parent, nitro_id) {\n        // send to your server to fetch data S2S\n    })\n    \n    \nOnce the required information has been provided in the callback function, send a request to your backend providing these IDs. Thereafter, make a request to nitro backend to fetch the corresponding details.\n\n**At server side:**\n- Method: GET\n- Header: Authorization Bearer `<BEARER TOKEN>` [THIS TOKEN IS SPECIFIC TO - YOUR ORGANISATION. PLEASE USE IT CAREFULLY]\n- URL: `https://t.makehook.ws/jsv1/contact-details/<token>/< parent_id>/<nitro_id>`\n- Response: \n\n```{\n    code: 2001,\n    identified_data: {\n        email: < EMAIL>,\n        phone: < PHONE>,\n        consent_data: {\n            is_phone_consented: true/false,\n            is_email_consented: true/false,\n        },\n        message: "ok"	<h1 class="toc-header" id="server-to-server-s2s-integration-guide"><a href="#server-to-server-s2s-integration-guide" class="toc-anchor">¶</a> Server-to-Server (S2S) Integration Guide</h1>\n<h3 class="toc-header" id="what-youll-need"><a href="#what-youll-need" class="toc-anchor">¶</a> What you'll need</h3>\n<p><strong>To fetch data from Nitro Backend, you need the following IDs:</strong></p>\n<ul>\n<li>token: <code>&lt;ORGANISATION_TOKEN&gt;</code></li>\n<li>parent: <code>&lt;PARENT&gt;</code></li>\n<li>nitro_id: <code>&lt;NITRO_ID&gt;</code></li>\n</ul>\n<p><strong>These IDs are available fron nitro.js at the client side and can be fetched in 2 ways:</strong></p>\n<ol>\n<li>Using ready function in nitroSettings<br>\nJust like onIdentify function in nitroSettings, declare another function named ready. This function will be called once all the required IDs are loaded.</li>\n</ol>\n<p>For example, Your nitroSettings object should look something like:</p>\n<pre class="prismjs line-numbers" v-pre="true"><code class="language-">window.nitro = {\n    events: {\n        onIdentify: function() {\n            // ...\n        }\n    },\n    ready: function(token, parent, nitro_id) {\n        // ...\n    }\n},\n</code></pre>\n<ol start="2">\n<li>Using nitro.ready() function<br>\nnitro.ready function takes a function as a parameter, which is called once Nitro Script gets loaded.</li>\n</ol>\n<p>For example:</p>\n<pre class="prismjs line-numbers" v-pre="true"><code class="language-">nitro.ready(function(token, parent, nitro_id) {\n    // send to your server to fetch data S2S\n})\n</code></pre>\n<p>Once the required information has been provided in the callback function, send a request to your backend providing these IDs. Thereafter, make a request to nitro backend to fetch the corresponding details.</p>\n<p><strong>At server side:</strong></p>\n<ul>\n<li>Method: GET</li>\n<li>Header: Authorization Bearer <code>&lt;BEARER TOKEN&gt;</code> [THIS TOKEN IS SPECIFIC TO - YOUR ORGANISATION. PLEASE USE IT CAREFULLY]</li>\n<li>URL: <code>https://t.makehook.ws/jsv1/contact-details/&lt;token&gt;/&lt; parent_id&gt;/&lt;nitro_id&gt;</code></li>\n<li>Response:</li>\n</ul>\n<pre class="prismjs line-numbers" v-pre="true"><code class="language-{">    code: 2001,\n    identified_data: {\n        email: &lt; EMAIL&gt;,\n        phone: &lt; PHONE&gt;,\n        consent_data: {\n            is_phone_consented: true/false,\n            is_email_consented: true/false,\n        },\n        message: "ok"</code></pre>\n	[{"title":"Server-to-Server (S2S) Integration Guide","anchor":"#server-to-server-s2s-integration-guide","children":[]}]	markdown	2024-11-28T12:16:16.220Z	2024-11-28T13:12:33.409Z	markdown	en	3	3	{"js":"","css":""}
26	s2s-last-n-events	6e5bc46c46f3ac2604a79efe1a2e18b19afea1c6	Server-to-Server Fetch Last 'N' Events		f	t	\N			# Server-to-Server (S2S) Fetch Last 'N' Events\n\n\n### What you'll need\n\n**To fetch data from Nitro Backend, you need the following IDs:**\n- token: `<ORGANISATION_TOKEN>`\n- parent: `<PARENT>`\n- nitro_id: `<NITRO_ID>`\n\n\n\n**These IDs are available fron nitro.js at the client side and can be fetched in 2 ways:**\n1. Using ready function in nitroSettings\n    Just like onIdentify function in nitroSettings, declare another function named ready. This function will be called once all the required IDs are loaded.\n    \nFor example, Your nitroSettings object should look something like:\n\n    window.nitro = {\n        events: {\n            onIdentify: function() {\n                // ...\n            }\n        },\n        ready: function(token, parent, nitro_id) {\n            // ...\n        }\n    },\n    \n    \n2. Using nitro.ready() function\n    nitro.ready function takes a function as a parameter, which is called once Nitro Script gets loaded.\n    \nFor example:\n\n    nitro.ready(function(token, parent, nitro_id) {\n        // send to your server to fetch data S2S\n    })\n    \n    \nOnce the required information has been provided in the callback function, send a request to your backend providing these IDs. Thereafter, make a request to nitro backend to fetch the corresponding details.\n\n**At server side:**\n- Method: GET\n- Header: Authorization Bearer `<BEARER TOKEN>` [THIS TOKEN IS SPECIFIC TO - YOUR ORGANISATION. PLEASE USE IT CAREFULLY]\n- URL: `https://t.makehook.ws/jsv1/events/<org_id>/<nitro_id>`\n\n> Query Param: To fetch n-numbers of events, pass _n as query param with the desired number of events required.\n{.is-info}\n\nexample:\n- URL: `https://t.makehook.ws/jsv1/events/<org_id>/<nitro_id>?_n=5`\n\n> Maximum number of 25 events are allowed, and default last 5 events are sent.\n\n\n- Response: \n\n```\n{\n    "code":2001,\n    "events":[\n            {\n                "id":"<NITRO_ID>",\n                "org":"<ORG_ID>",\n                "event":"<EVENT_NAME>",\n                "url":"<VISITED_PAGE_URL>",\n                "created_at":"<DATE_CREATED_FORMAT__ISO_8601_FORMAT>",\n            },\n        ],\n    "message":"OK",\n}	<h1 class="toc-header" id="server-to-server-s2s-fetch-last-n-events"><a href="#server-to-server-s2s-fetch-last-n-events" class="toc-anchor">¶</a> Server-to-Server (S2S) Fetch Last 'N' Events</h1>\n<h3 class="toc-header" id="what-youll-need"><a href="#what-youll-need" class="toc-anchor">¶</a> What you'll need</h3>\n<p><strong>To fetch data from Nitro Backend, you need the following IDs:</strong></p>\n<ul>\n<li>token: <code>&lt;ORGANISATION_TOKEN&gt;</code></li>\n<li>parent: <code>&lt;PARENT&gt;</code></li>\n<li>nitro_id: <code>&lt;NITRO_ID&gt;</code></li>\n</ul>\n<p><strong>These IDs are available fron nitro.js at the client side and can be fetched in 2 ways:</strong></p>\n<ol>\n<li>Using ready function in nitroSettings<br>\nJust like onIdentify function in nitroSettings, declare another function named ready. This function will be called once all the required IDs are loaded.</li>\n</ol>\n<p>For example, Your nitroSettings object should look something like:</p>\n<pre class="prismjs line-numbers" v-pre="true"><code class="language-">window.nitro = {\n    events: {\n        onIdentify: function() {\n            // ...\n        }\n    },\n    ready: function(token, parent, nitro_id) {\n        // ...\n    }\n},\n</code></pre>\n<ol start="2">\n<li>Using nitro.ready() function<br>\nnitro.ready function takes a function as a parameter, which is called once Nitro Script gets loaded.</li>\n</ol>\n<p>For example:</p>\n<pre class="prismjs line-numbers" v-pre="true"><code class="language-">nitro.ready(function(token, parent, nitro_id) {\n    // send to your server to fetch data S2S\n})\n</code></pre>\n<p>Once the required information has been provided in the callback function, send a request to your backend providing these IDs. Thereafter, make a request to nitro backend to fetch the corresponding details.</p>\n<p><strong>At server side:</strong></p>\n<ul>\n<li>Method: GET</li>\n<li>Header: Authorization Bearer <code>&lt;BEARER TOKEN&gt;</code> [THIS TOKEN IS SPECIFIC TO - YOUR ORGANISATION. PLEASE USE IT CAREFULLY]</li>\n<li>URL: <code>https://t.makehook.ws/jsv1/events/&lt;org_id&gt;/&lt;nitro_id&gt;</code></li>\n</ul>\n<blockquote class="is-info">\n<p>Query Param: To fetch n-numbers of events, pass _n as query param with the desired number of events required.</p>\n</blockquote>\n<p>example:</p>\n<ul>\n<li>URL: <code>https://t.makehook.ws/jsv1/events/&lt;org_id&gt;/&lt;nitro_id&gt;?_n=5</code></li>\n</ul>\n<blockquote>\n<p>Maximum number of 25 events are allowed, and default last 5 events are sent.</p>\n</blockquote>\n<ul>\n<li>Response:</li>\n</ul>\n<pre class="prismjs line-numbers" v-pre="true"><code class="language-">{\n    "code":2001,\n    "events":[\n            {\n                "id":"&lt;NITRO_ID&gt;",\n                "org":"&lt;ORG_ID&gt;",\n                "event":"&lt;EVENT_NAME&gt;",\n                "url":"&lt;VISITED_PAGE_URL&gt;",\n                "created_at":"&lt;DATE_CREATED_FORMAT__ISO_8601_FORMAT&gt;",\n            },\n        ],\n    "message":"OK",\n}</code></pre>\n	[{"title":"Server-to-Server (S2S) Fetch Last 'N' Events","anchor":"#server-to-server-s2s-fetch-last-n-events","children":[]}]	markdown	2024-12-10T08:47:34.566Z	2024-12-10T08:47:40.465Z	markdown	en	3	3	{"js":"","css":""}
1	home	b29b5d2ce62e55412776ab98f05631e0aa96597b	Documentation for Nitro		f	t	\N			\n* [Nitro Js API Integration Guide](/integration-guide)\n\n* [Shopify Custom App Installation Guide](/shopify-custom-app)\n\n* [API Integration Orbis<>Nitro](/API-integration)\n\n* [Nitro Exporting Data](/exporting-data)\n\n* [Nitro Popup](/pop-up-modal)\n\n* [Nitro API Reference](/nitro-api)\n\n* [Nitro User Guide](/en/nitrox-user-guide)\n\t* [NitroX Quick Start Guide](/en/quick-start-guide)\n  * [NitroX - Consent Management](/en/consent-management)\n  * [NitroX - High Intent Users](/en/high-intent-users)\n  \n * [NitroX - Prefill Templates Image Dimensions](/en/prefill-image-details)\n  \n* [Nitrox WordPress/WooCommerce Plugin Installation Guide](/en/wordpress-plugin)\n\n* [Nitrox Magento Plugin Installation Guide](/en/magento-plugin)\n\n* [Nitrox Event Schemas](/en/event-schemas)\n\n\n* [NitroX Blackbox Regression Checklist](/en/nitroxregressionchecklist)\n\n* [SSO Regression Checklist](/en/ssoregressionchecklist)\n\n* [Nitro<>Zoho Integration Guide](/en/nitro-zoho-integration)\n\n* [Server-to-Server(S2S) Integration Guide](/en/S2S-integration)\n\n* [Server-to-Server(S2S) Fetch Last 'N' Events](/en/s2s-last-n-events)\n  \n* [DPDP Act](/en/DPDP-Act) \n\n\n \n\n	<ul>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/integration-guide">Nitro Js API Integration Guide</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/shopify-custom-app">Shopify Custom App Installation Guide</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/API-integration">API Integration Orbis&lt;&gt;Nitro</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/exporting-data">Nitro Exporting Data</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/pop-up-modal">Nitro Popup</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/nitro-api">Nitro API Reference</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/nitrox-user-guide">Nitro User Guide</a></p>\n<ul>\n<li><a class="is-internal-link is-valid-page" href="/en/quick-start-guide">NitroX Quick Start Guide</a></li>\n<li><a class="is-internal-link is-valid-page" href="/en/consent-management">NitroX - Consent Management</a></li>\n<li><a class="is-internal-link is-valid-page" href="/en/high-intent-users">NitroX - High Intent Users</a></li>\n</ul>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/prefill-image-details">NitroX - Prefill Templates Image Dimensions</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/wordpress-plugin">Nitrox WordPress/WooCommerce Plugin Installation Guide</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/magento-plugin">Nitrox Magento Plugin Installation Guide</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/event-schemas">Nitrox Event Schemas</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/nitroxregressionchecklist">NitroX Blackbox Regression Checklist</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/ssoregressionchecklist">SSO Regression Checklist</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/nitro-zoho-integration">Nitro&lt;&gt;Zoho Integration Guide</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/S2S-integration">Server-to-Server(S2S) Integration Guide</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/s2s-last-n-events">Server-to-Server(S2S) Fetch Last 'N' Events</a></p>\n</li>\n<li>\n<p><a class="is-internal-link is-valid-page" href="/en/DPDP-Act">DPDP Act</a></p>\n</li>\n</ul>\n	[]	markdown	2024-01-24T07:31:02.437Z	2024-12-19T11:55:51.237Z	markdown	en	3	1	{"js":"","css":""}
21	magento-plugin	8e4030c59ee473ab2510506bb99f5fea87ebec0c	Magento Plugin Installation Guide		f	t	\N			# Magento Plugin Installation Guide \n\n### Installation Steps:\n- Download the latest version of the Nitrox module/plugin from the [Nitrox EventBridge](https://cdn.nitrocommerce.ai/plugins/EventBridge.zip).\n- Create a directory "Nitrox" in app/code.\n- Paste the downloaded plugin inside Nitrox Directory "EventBridge".\n- Run this command on magento root and check plugin is visible with "Nitrox_EventBridge" :- bin/magento module:status\n- then Run this command:-  bin/magento module:enable Nitrox_EventBridge --clear-static-content\n- then run this command :- bin/magento setup:upgrade\n- then run this command:- bin/magento setup:di:compile\n- then run this command:- bin/magento cache:clean\n- then login your magento admin panel and find nitrox in left sidebar, then add your Organization Token from nitrox dashboard.	<h1 class="toc-header" id="magento-plugin-installation-guide"><a href="#magento-plugin-installation-guide" class="toc-anchor">¶</a> Magento Plugin Installation Guide</h1>\n<h3 class="toc-header" id="installation-steps"><a href="#installation-steps" class="toc-anchor">¶</a> Installation Steps:</h3>\n<ul>\n<li>Download the latest version of the Nitrox module/plugin from the <a class="is-external-link" href="https://cdn.nitrocommerce.ai/plugins/EventBridge.zip">Nitrox EventBridge</a>.</li>\n<li>Create a directory "Nitrox" in app/code.</li>\n<li>Paste the downloaded plugin inside Nitrox Directory "EventBridge".</li>\n<li>Run this command on magento root and check plugin is visible with "Nitrox_EventBridge" :- bin/magento module:status</li>\n<li>then Run this command:-  bin/magento module:enable Nitrox_EventBridge --clear-static-content</li>\n<li>then run this command :- bin/magento setup:upgrade</li>\n<li>then run this command:- bin/magento setup:di:compile</li>\n<li>then run this command:- bin/magento cache:clean</li>\n<li>then login your magento admin panel and find nitrox in left sidebar, then add your Organization Token from nitrox dashboard.</li>\n</ul>\n	[{"title":"Magento Plugin Installation Guide","anchor":"#magento-plugin-installation-guide","children":[]}]	markdown	2024-10-07T13:04:57.288Z	2024-12-31T08:39:49.485Z	markdown	en	3	3	{"js":"","css":""}
\.