@omneo/omneo-sdk v1.25.0

Omneo JS SDK

A JavaScript Library to interface with the Omneo API.

Getting started

To get started with the Omneo SDK, follow the instructions below

• Installation
• Authentication
• Import

Installation

Omneo SDK is available as an npm package:

// npm
npm install @omneo/omneo-sdk

// yarn
yarn add @omneo/omneo-sdk

Authentication

All requests to the Omneo API must be authenticated with an OAuth2 bearer token. Please review the Authentication Docs to learn more.

Import

import with ES6 like this:

import { Omneo } from '@omneo/omneo-sdk'

const client = new Omneo({
  token: 'Your token',
  tenant: 'Your omneo tenant'
})

Documentation and Examples

Using Profiles

Using Call

You can make calls manually to omneo using the call method. All API functions in this SDK use this method to call the API. This will cover any new API functionality not yet supported by the SDK.

Make your own custom authenticated request like the below:

 client.call({
    method: 'post',
    endpoint: '/profiles',
    body: { first_name: 'test', last_name: 'test', email: 'test@test.com' }
  })