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 Invites plugin powers referral and invite-based acquisition flows. It tracks invite sends, monitors profile creation from invites, and issues incentives to both the referrer and the new member.

​
How it works

  1. An existing member generates an invite link (via Profile Portal or your front-end implementation)
  2. The invite link contains a unique invite_id parameter
  3. When a new member registers using the invite link, the invite is recorded and associated with the referrer’s profile
  4. Reactions can fire to issue rewards or benefits to both parties

​
Integration overview

The Invites plugin is a separately deployed Omneo extension. Your implementation team will configure and deploy it for your tenant. You will need to provide:
  • A Meta/Facebook Sendgrid template for invite emails (if using built-in email delivery)
  • The Omneo API token scopes: read-benefit-definitions, read-reward-definitions, read-tier-definitions, create-profiles, read-profiles, update-profiles, read-identities

​
Front-end integration

The plugin exposes a Shapes-compatible JavaScript interface. On your join/registration page, check for the invite_id URL parameter and pass it to the registration flow: 
const urlParams = new URLSearchParams(window.location.search)
const inviteId = urlParams.get('invite_id')

if (inviteId) {
  // Store the invite ID in the session or pass it in the registration payload
  sessionStorage.setItem('omneo_invite_id', inviteId)
}
When creating the new profile, include the invite_id so Omneo can associate it with the referrer.

​
Profile Portal

Profile Portal has a built-in invites/referrals component. If you are using Profile Portal, the invite send and join flows are handled automatically — no custom front-end code required. Configure the invite settings in Profile Portal’s custom fields section.
Content needed: full API endpoint reference for the Invites plugin, invite status lifecycle, reward configuration for referrer vs referee, and webhook events fired by the plugin.