OMX Logo
Quick Start

Getting Started with OMX SDK

Get up and running with OMX in under 5 minutes

Installation

Installation
npm install @omx-sdk/core

Or install specific modules for your use case:

npm install @omx-sdk/geotrigger
npm install @omx-sdk/email
Basic Usage
Create your first geo-trigger in just a few lines of code
typescript
1import { createOmxClient } from 'omx-sdk';
2const omx = createOmxClient({
3 clientId: process.env.OMX_CLIENT_ID,
4 secretKey: process.env.OMX_SECRET_KEY
5});
6try {
7 const geoTrigger = await omx.geoTrigger.create({
8 name: "Coffee Shop Promo",
9 location: {
10 lat: 43.6532,
11 lng: -79.3832
12 },
13 radius: 100,
14 onEnter: {
15 notification: {
16 title: "Welcome!",
17 body: "Get 30% off your order!"
18 }
19 }
20 });
21
22 console.log('GeoTrigger created:', geoTrigger.id);
23} catch (error) {
24 console.error('Failed to create GeoTrigger:', error.message);
25}

OMX SDK Modules

core

@omx-sdk/core

Core
Core module for OMX SDK with authentication and shared utilities
v1.0.1 • 20 days ago
Module
notification

@omx-sdk/notification

Messaging
Push notification functionality for omx-sdk
v1.0.1 • 20 days ago
Module
email

@omx-sdk/email

Messaging
Email sending functionality for omx-sdk
v1.0.1 • 20 days ago
Module
geotrigger

@omx-sdk/geotrigger

Location
Geolocation trigger functionality for omx-sdk
v1.0.1 • 20 days ago
Module
beacon

@omx-sdk/beacon

Location
Beacon integration functionality for omx-sdk
v1.0.1 • 20 days ago
Module
webhook

@omx-sdk/webhook

Integration
Webhook handling functionality for omx-sdk
v1.0.1 • 20 days ago
Module
campaign

@omx-sdk/campaign

Marketing
Campaign management module for OMX SDK
v1.0.11 • 6 days ago
Module

Next Steps

Explore Modules

Discover all 7 OMX SDK modules and their capabilities in our comprehensive modules showcase.

View All Modules
Build Workflows

Create complex automation workflows with our visual editor.

Interactive Playground

typescript
const result = await omx.geoTrigger.create({
"location": {
"lat": 43.6532,
"lng": -79.3832
},
"radius": 100,
"action": {
"type": "email",
"template": "welcome_toronto"
}
});

Response

Send a request to see the response