Home › Guides › Connect your own systems with the Developer API and webhooks

All apps · 10 min

Connect your own systems with the Developer API and webhooks

Create a key, read Omni Pass balances, reviews, wishlists and referrals from your CRM or ERP, add tokens, and get a signed message when something changes.

1. Create a key

In Vikalp Omni → Settings → Developers, click New key. Pick Read only, or Read and change for a key that adds tokens or publishes reviews. The key is shown once: copy it into your system and keep it secret, like a password. The Developer API is on the Pro and Max plans.

2. Make a call

Send the key with every call as a Bearer token to https://api.vikalpomni.com/api/v1. Read a member’s Omni Pass balance and tier, list reviews, wishlists and referrals, publish or hide a review, or add and take tokens with a reason. Every answer says how many calls are left this minute.

3. Webhooks

On the same page, add an https address and pick its events: a balance changed, a tier changed, a review arrived, a referral completed. Each message is signed; check the signature before trusting it. If your address doesn’t answer, we try again 10 times over about 3 hours.

4. The full reference

Every address, field and error is on the developer page: vikalpomni.com/developers.

Stuck? Write to support@vikalpomni.com or press the chat button at the bottom right of your Vikalp Omni dashboard. We usually reply within a few hours.

Related guides