---
title: Opensend SDK User Guide Map
description: Top level guide for interacting with and using our Opensend SDK.
---

[Skip to content](https://help.opensend.com/how-do-i-implement-opensend-sdk#main-content)

[Contact Support](https://help.opensend.com/kb-tickets/new?hsLang=en)

[![Logo Black.png\]](https://help.opensend.com/hs-fs/hubfs/Logo%20Black.png?height=33&name=Logo%20Black.png)](https://opensend.com/)

Open main navigation

Close main navigation

- [Contact Support](https://help.opensend.com/kb-tickets/new)
- [Return to opensend.com](https://opensend.com/)

[Return to opensend.com](https://opensend.com/)

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Success Center](https://help.opensend.com/?hsLang=en)
2. [Getting started](https://help.opensend.com/getting-started?hsLang=en)
3. [Opensend SDK](https://help.opensend.com/getting-started?hsLang=en#opensend-sdk)

# Opensend SDK User Guide Map

## This is your map for navigating different functionality. 

#### The OIR SDK is designed to capture various events occurring on your website, providing valuable insights into customer behavior and interactions. 

**Key Features:**

- **Queue-first model:** Commands pushed before the SDK loads are buffered and executed once ready

- **Asynchronous loading**: Does not impact page load performance
- **Cross-tab synchronization**: Consistent tracking across browser tabs

### Public API

| **Method** | **Description** |
| --- | --- |
| cfg() | Configure additional SDK options |
| push() | Track events, identify users, set global data |
| version() | Returns the build version (YYMMDD format) |

### 1. Getting Started

Start here to install and configure the SDK on your website.

| **Guide** | **Description** |
| --- | --- |
| [Installation Guide](https://help.opensend.com/opensend-sdk/installation-guide?hsLang=en) | Install the SDK via CDN |
| [Quick Start Guide](https://help.opensend.com/opensend-sdk/quickstart-guide?hsLang=en) | Track your first event in minutes |
| [Configuration Guide](https://help.opensend.com/opensend-sdk/configuration-guide?hsLang=en) | First-party tracking, advanced options |

### 2. Global Custom Data

Set persistent data that will be included with all events.

| **Guide** | **Description** |
| --- | --- |
| [Global Custom Data](https://help.opensend.com/opensend-sdk/global-custom-data?hsLang=en) | Set persistent data for all events |

### 3. User Identification

Identify users with email or phone for personalized tracking.

| **Guide** | **Description** |
| --- | --- |
| [User Identification](https://help.opensend.com/opensend-sdk/user-identification-guide?hsLang=en) | Identify users with email/phone |

### 4. Automatic Tracking

These features work automatically after SDK installation—no additional code required.

| **Guide** | **Description** |
| --- | --- |
| [Page View Tracking ](https://help.opensend.com/opensend-sdk/page-viewed-event?hsLang=en) | Automatic page view on every page |
| [Active On Site Tracking ](https://help.opensend.com/opensend-sdk/active-onsite-tracking?hsLang=en) | Automatic engagement after time threshold |

### 5. Event Tracking

Track custom business events and ecommerce interactions.

| **Guide** | **Description** |
| --- | --- |
| [Custom Events Guide ](https://help.opensend.com/opensend-sdk/custom-events-guide?hsLang=en) | Track custom business events |
| [Ecommerce Events ](https://help.opensend.com/opensend-sdk/ecommerce-events?hsLang=en) | Product views, cart, checkout, purchases |

### 6. Help & Support

| **Guide** | **Description** |
| --- | --- |
| [Troubleshooting Guide ](https://help.opensend.com/opensend-sdk/troubleshooting-guide?hsLang=en) | Common issues and solutions |
| [FAQ](https://help.opensend.com/opensend-sdk/faq?hsLang=en) | Frequently asked questions |

### Quick Reference

#### 1. Install the SDK

```
<script type="text/javascript">  !(function (s) {    var o = s.createElement('script'),      u = s.getElementsByTagName('script')[0];    o.src = 'https://cdn.aggle.net/oir/oir.min.js';    o.async = !0;    o.setAttribute('oirtyp', 'YOUR_INTEGRATION_TYPE');    o.setAttribute('oirid', 'YOUR_INTEGRATION_ID');    u.parentNode.insertBefore(o, u);  })(document);</script>
```

 

#### 2. Set Global Data (Optional)

```
_oirtrk.push(['set', 'puid', 'your-user-id']);_oirtrk.push(['set', 'campaignId', 'summer_2024']);
```

 

#### 3. Track Events

```
_oirtrk.push([  'event',  {    event: 'button_click',    payload: {      button_name: 'Sign Up',    },  },]);
```

 

#### 4. Identify Users

```
_oirtrk.push([  'identify',  {    email: 'user@example.com',  },]);
```

**Need help?** Check the [Troubleshooting Guide](https://help.opensend.com/opensend-sdk/troubleshooting-guide?hsLang=en) or [FAQ](https://help.opensend.com/opensend-sdk/faq?hsLang=en).

- [Getting started](https://help.opensend.com/getting-started?hsLang=en#main-content)
  
  
  
  
  
    - [Start Here!](https://help.opensend.com/getting-started?hsLang=en#start-here)
    - [Installation and Setup](https://help.opensend.com/getting-started?hsLang=en#installation-and-setup)
    - [CNAME Setup](https://help.opensend.com/getting-started?hsLang=en#cname-setup)
    - [Opensend SDK](https://help.opensend.com/getting-started?hsLang=en#opensend-sdk)
- [Best Practices to Maximize Revenues](https://help.opensend.com/best-practices-to-maximize-revenues?hsLang=en#main-content)
  
  
  
  
  
    - [Direct-to-consumer](https://help.opensend.com/best-practices-to-maximize-revenues?hsLang=en#direct-to-consumer)
    - [Business-to-business](https://help.opensend.com/best-practices-to-maximize-revenues?hsLang=en#business-to-business)
    - [Deliverability](https://help.opensend.com/best-practices-to-maximize-revenues?hsLang=en#deliverability)
- [Dashboards & Reports](https://help.opensend.com/dashboards-reports?hsLang=en#main-content)
  
  
  
  
  
    - [Klaviyo Reports](https://help.opensend.com/dashboards-reports?hsLang=en#klaviyo-reports)
    - [Iterable Reports](https://help.opensend.com/dashboards-reports?hsLang=en#iterable-reports)
- [Reconnect](https://help.opensend.com/reconnect?hsLang=en#main-content)
  
  
  
  
  
    - [Klaviyo](https://help.opensend.com/reconnect?hsLang=en#klaviyo)
    - [Iterable](https://help.opensend.com/reconnect?hsLang=en#iterable)
    - [Bloomreach](https://help.opensend.com/reconnect?hsLang=en#bloomreach)
    - [Attentive](https://help.opensend.com/reconnect?hsLang=en#attentive)
    - [Salesforce Marketing Cloud](https://help.opensend.com/reconnect?hsLang=en#salesforce-marketing-cloud)
- [Personas](https://help.opensend.com/personas?hsLang=en)
- [Revive](https://help.opensend.com/revive?hsLang=en)
- [Integrations](https://help.opensend.com/integrations?hsLang=en#main-content)
  
  
  
  
  
    - [API Keys and Account IDs](https://help.opensend.com/integrations?hsLang=en#api-keys-and-account-ids)
    - [Bloomreach](https://help.opensend.com/integrations?hsLang=en#bloomreach)
    - [Braze](https://help.opensend.com/integrations?hsLang=en#braze)
    - [Facebook](https://help.opensend.com/integrations?hsLang=en#facebook)
    - [Google](https://help.opensend.com/integrations?hsLang=en#google)
    - [Iterable](https://help.opensend.com/integrations?hsLang=en#iterable)
    - [Klaviyo](https://help.opensend.com/integrations?hsLang=en#klaviyo)
    - [Listrak](https://help.opensend.com/integrations?hsLang=en#listrak)
    - [Sendlane](https://help.opensend.com/integrations?hsLang=en#sendlane)
    - [Suppression List](https://help.opensend.com/integrations?hsLang=en#suppression-list)
    - [Webhook](https://help.opensend.com/integrations?hsLang=en#webhook)
    - [Yotpo](https://help.opensend.com/integrations?hsLang=en#yotpo)
    - [Zapier](https://help.opensend.com/integrations?hsLang=en#zapier)
    - [Attentive](https://help.opensend.com/integrations?hsLang=en#attentive)
    - [Salesforce Marketing Cloud](https://help.opensend.com/integrations?hsLang=en#salesforce-marketing-cloud)
- [FAQs](https://help.opensend.com/faqs?hsLang=en)
- [General](https://help.opensend.com/general?hsLang=en)

[![Chill listening crop-3](https://help.opensend.com/hs-fs/hubfs/OpenSend_Logo%20icon%202.png?width=42&height=42&name=OpenSend_Logo%20icon%202.png "Chill listening crop-3")](https://www.opensend.com/)

Opensend Help Center

Copyright © 2026, Opensend Inc