OMX Logo
Documentation
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
import { OMXCore } from '@omx-sdk/core'
import { GeoTrigger } from '@omx-sdk/geotrigger'
import { EmailService } from '@omx-sdk/email'

// Initialize with your API key
const omx = new OMXCore('your-api-key')
const geoTrigger = new GeoTrigger(omx)
const emailService = new EmailService(omx)

// Create a geo-trigger with email action
const trigger = await geoTrigger.create({
  location: { lat: 43.6532, lng: -79.3832 },
  radius: 100, // meters
  name: 'Downtown Toronto Welcome',
  actions: [{
    type: 'email',
    config: {
      to: 'user@example.com',
      subject: 'Welcome to Toronto!',
      template: 'welcome_toronto'
    }
  }]
})

console.log('Trigger created:', trigger.id)

Available SDK Modules

@omx-sdk/core
Core module with authentication and shared utilities
npm install @omx-sdk/core
@omx-sdk/geotrigger
Geolocation trigger functionality
npm install @omx-sdk/geotrigger
@omx-sdk/email
Email sending functionality
npm install @omx-sdk/email
@omx-sdk/push-notification
Push notification functionality
npm install @omx-sdk/push-notification
@omx-sdk/webhook
Webhook handling functionality
npm install @omx-sdk/webhook
@omx-sdk/beacon
Beacon integration functionality
npm install @omx-sdk/beacon
@omx-sdk/campaign
Campaign management module
npm install @omx-sdk/campaign

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.

API Sandbox

Response

Send a request to see the response