Get Started
iOmniHub provides REST APIs and Webhooks for you to build on top of iOmniHub and connect your internal systems with iOmniHub as well.
REST APIs and Webhooks are available in Business and Enterprise Package.
Authentication
Any API request needs to have api_key
in the params.
Obtaining the Key
To obtain your authentication key, navigate to your Team Settings in the dashboard. Locate the API Key and store it.
Using the Key
Add api_key
in the params of your API call. All API requests must be made over HTTPS.
- Calls made over plain HTTP will fail.
- Any request without
api_key
in the params will also fail.
Key Security
Key Regeneration: In the event of a security breach or if you suspect your key has been compromised, regenerate a new key immediately. Contact Support for this.
Authentication Process
Once you have your API key, include it in the HTTP params of your requests under api_key
as specified in the API documentation. The header should look like this: