Skip to content

Latest commit

 

History

History
233 lines (200 loc) · 7.08 KB

File metadata and controls

233 lines (200 loc) · 7.08 KB
title Publish Your App
icon paper-plane
description Submit your app to the Omi app store. Learn the review process, guidelines, and best practices for a successful submission.

Overview

Ready to share your app with the Omi community? Publishing is done directly through the Omi mobile app.

flowchart LR
    D[Develop App] --> T[Test Thoroughly]
    T --> S[Submit via App]
    S --> R[Review Process]
    R --> P[Published!]
Loading
Most apps are reviewed within 24 hours No fees to submit or list your app

Before You Submit

Thoroughly test all functionality in Developer Mode: - Verify webhooks receive data correctly - Test with real conversations - Check error handling - Confirm notifications work (if applicable) Create compelling app store content: - **App Name**: Clear, descriptive (max 30 characters) - **Description**: Explain what your app does and why it's useful - **Category**: Choose the most relevant category - **Icon**: Upload a distinctive app icon Ensure your app follows all community guidelines (see below) For integration apps, confirm your server is: - Using HTTPS - Responding quickly (< 5 seconds) - Handling errors gracefully - Available 24/7

How to Submit

Launch the Omi mobile app on your device Go to **Explore** → Find your app in **My Apps** or create a new one Fill in all required fields: - Name and description - Category selection - Capabilities and permissions - Webhook URLs (for integration apps) Change your app's visibility from **Private** to **Public** Tap **Submit** and wait for the review process You can continue to update and test your app while it's under review. Changes won't affect the review process.

Community Guidelines

Apps that violate these guidelines will be rejected or removed from the store. No content promoting hate, discrimination, or harassment of any kind Consider a general audience - avoid explicit or adult content If providing facts or advice, strive for correctness and clarity Respect user data, obtain clear consent, and follow data protection best practices No facilitating illegal activities or violating terms of service Be clear about what your app does and what data it accesses

Review Process

During review, we verify:
| Check | Description |
|-------|-------------|
| **Functionality** | App works as described |
| **Guidelines** | Follows community guidelines |
| **Security** | No obvious security issues |
| **Endpoints** | Webhooks respond correctly (integration apps) |
| **Content** | Description is accurate and appropriate |
- **Most apps**: Reviewed within 24 hours - **Complex integrations**: May take 2-3 days - **Weekends/holidays**: May experience delays
You'll receive a notification when your app is approved or if changes are needed.
Avoid these common issues:
1. **Broken webhooks** - Endpoint returns errors or times out
2. **Misleading description** - App doesn't do what it claims
3. **Missing permissions** - Requesting more access than needed
4. **Guideline violations** - Content issues
5. **Poor user experience** - Confusing or broken functionality
If your app is rejected:
1. Review the feedback provided
2. Make necessary changes
3. Test thoroughly
4. Resubmit for review

There's no limit on resubmissions - we want to help you succeed!

Best Practices for Success

- Start with what the app does - Explain the value to users - Include usage examples - List any requirements - Productivity: Task management, notes, workflows - Health: Fitness, wellness, medical - Social: Communication, sharing - Entertainment: Fun, games, creativity - Use simple, recognizable imagery - Ensure visibility at small sizes - Match your app's purpose - Avoid text-heavy designs - Monitor your webhook uptime - Respond to user feedback - Update for new Omi features - Keep your app fresh

After Publishing

Track your app's install count and user engagement in the Omi app Users may reach out with questions or suggestions - be responsive! Keep your app current with new features and improvements Connect with other developers in the [Omi Discord](http://discord.omi.me) for support and collaboration Successful apps are ones that solve real problems for users. Focus on delivering value, and the installs will follow!

Related Documentation

Create apps without a server Build webhook-based integrations Add custom tools to Omi chat Overview of all app types