Overview
Omi supports two types of notifications you can send to users:Direct notifications
Send immediate, exact-text messages to specific users
Proactive notifications
AI-generated contextual messages based on real-time conversations
Direct flow
Proactive flow
Direct notifications
Send immediate messages to specific users. Use them for alerts, updates, and responses to user actions.Use cases
Use cases
- Task reminders and event notifications
- Service updates or changes
- Real-time alerts and warnings
- Responses to user queries
- New feature announcements
API reference
Query Parameters:
Implementation
Get credentials
You’ll need your App ID and App Secret from the Omi developer portal.
Send notification
Make a POST request with the user ID and message:
Handle response
Check the response status code to confirm delivery.
Code examples
- Node.js
- Python
Proactive notifications
Context-aware, AI-generated notifications that use user data during real-time conversations. You provide a prompt template, and Omi generates the personalized message.Unlike direct notifications, proactive notifications require an app with specific capabilities and user-granted permissions.
Use cases
Use cases
- Real-time mentoring advice during meetings
- Context-aware suggestions based on conversation topics
- Personalized insights based on user’s goals
- Intelligent responses to specific phrases
- Meeting action item reminders
How it works
How it works
- User installs your app and grants permissions
- During conversations, Omi sends transcripts to your webhook
- Your webhook analyzes the transcript and returns a prompt template
- Omi fills in user context (name, facts, etc.) and generates the notification
- User receives a personalized, contextual notification
App configuration
Your app needs these capabilities:Available scopes
Webhook implementation
Your webhook receives real-time transcripts and returns notification prompts: Incoming Request:Complete example
- Python (FastAPI)
- Node.js (Express)
Testing
Enable developer mode
Open Omi app → Settings → Developer Mode
Install your app
Install your app in Developer Mode and grant requested scopes
Set webhook URL
Configure your webhook URL in Developer Settings
Trigger notifications
Start a conversation and say trigger phrases (e.g., “what do you think?”)
Verify
Notification should appear within 30 seconds
Rate Limit: 1 proactive notification per user per app every 30 seconds.
Best practices
Rate limiting
- Implement delays between notifications
- Avoid duplicate messages
- Group related notifications
Content quality
- Keep messages concise and clear
- Include relevant context
- Use appropriate urgency levels
Error handling
- Implement retry with exponential backoff
- Log errors for debugging
- Monitor delivery status
Security
- Store credentials securely
- Validate user IDs before sending
- Use HTTPS for all endpoints
Troubleshooting
Error codes
Direct notifications not sending
Direct notifications not sending
Check these:
- API credentials are correct
- User ID is valid
- Bearer token is properly formatted
- Request includes required headers
Proactive notifications not appearing
Proactive notifications not appearing
Check these:
- App has
proactive_notificationcapability enabled - User has installed your app
- User has granted requested scopes
- Webhook is returning proper response format
- Prompt is at least 5 characters
Notifications not contextual
Notifications not contextual
Solutions:
- Request additional scopes in app configuration
- Include more template variables in your prompt
- Make prompts more specific about using the context
Related documentation
Integration apps
Build webhook-based integrations
OAuth setup
Add authentication to your apps
Chat tools
Add custom tools to Omi chat
Submit your app
Publish your app to the store