Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

The Omneo SDK (formerly known as Shapes SDK) is a JavaScript library that enables developers to build Omneo-powered experiences directly on websites and web applications. It provides pre-built components (Shapes) and low-level API access for authenticated customers.

​
What the SDK enables

  • Authenticated profile access — securely identify a logged-in customer and load their Omneo profile data
  • Incentive display — surface reward balance, tier status, points, and benefits on the website
  • Interactive components — embed pre-built profile components (wishlists, transaction history, communication preferences) into the website
  • Real-time updates — profile data stays current as customers interact with the site
  • Custom experiences — build bespoke incentive and profile features using the SDK’s lower-level API methods

​
Authentication flow

The SDK requires an authenticated token to initialise. This is typically obtained via:
  1. Shopify Proxy — for Shopify stores, the proxy issues a token using the Shopify customer ID
  2. SFCC Proxy — for Salesforce Commerce Cloud sites
  3. OAuth — direct OAuth authentication for custom implementations
Once a token is obtained: 
var shapesClient = ShapesSDK.init({
  url: 'https://api.[tenant].getomneo.com/id',
  token: '[omneo_id_token]',
  logging: true
})

​
Shapes

Shapes are pre-built UI components that can be dropped into any website to surface Omneo data without custom development. Common Shapes include:
  • Reward balance widget
  • Transaction history feed
  • Profile completion prompt
  • Communication preference form
  • Wishlist component
Content needed: full SDK documentation including all available Shapes, configuration options, and authentication implementation guide.