> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Mini apps introduction

> Build dashboards and inbox widgets with Companion and run them inside OpenCX. Learn where apps live, who can build or open them, and how one goes live.

A mini app is a small tool your team builds in the OpenCX dashboard by describing it to Companion. Use one when the built-in reports or the session sidebar don't show what your team needs, such as a dashboard cut your way or a widget that looks something up for the session you're working on.

> [!NOTE]
>
> Open **Apps** in the sidebar of your [OpenCX dashboard](https://platform.open.cx/apps). Building an app requires the **Mini apps** and **Companion** permissions with Write access in **Settings → Roles**.

## What you can build

Every app is one of two kinds. Companion picks the kind from your request, and asks when it can't tell.

| Kind | Where it runs | What it knows when it opens | Examples |
| - | - | - | - |
| Dashboard app | Its own page, opened from **Apps** or pinned under **Reports & Apps** | Who is viewing it | Automation rate by channel this week, first-response time by team, a timesheet of agent hours |
| Inbox widget | A card in the session sidebar of the inbox | The open session, its contact, and who is viewing it | A widget that runs one of your actions for the current session, triggers a workflow, or shows order and delivery details |

An app can work with:

* **Your OpenCX data**: sessions, contacts, reports and more, limited to the permissions approved when the app is published.
* **Your own systems**, by running the [actions](https://docs.open.cx/actions/introduction.md) and workflows you already have. An app never holds keys or passwords itself.
* **Specific outside domains**, such as map tiles, when the publisher approves them.
* **Files**: it can read a CSV or Excel file you pick and let you download what it generates.

[Build and publish a mini app](https://docs.open.cx/apps/build-and-publish.md) covers permissions and domains in detail.

## Where apps live

| Place | What you find there |
| - | - |
| **Apps** in the sidebar | The library. Authors see every app, including drafts. Everyone else sees the published apps shared with them. |
| **Companion** | Where apps are built and changed. Dashboard apps open in Companion's browser panel. |
| **Reports & Apps** in the sidebar | Dashboard apps pinned for the whole workspace, next to the built-in report pages. |
| Session sidebar in the inbox | Inbox widgets, under **Widgets**, pinned automatically when an app is shared with you. |

## How an app goes live

1. You describe the app to Companion. It builds a **draft** and shows a live preview beside the chat.
2. You preview the draft on real data and ask Companion for changes.
3. You **publish** it. Publishing approves the permissions and domains the app uses and makes that version live.
4. You choose which roles can open it. Dashboard apps can then be pinned under **Reports & Apps**. Inbox widgets appear in the inbox for everyone they're shared with.

Nobody else sees a draft. When you change a published app, your team keeps the published version until you publish again.

## Who can do what

Permission names below are the labels in [Settings → Roles](https://platform.open.cx/settings/roles).

| To | You need |
| - | - |
| Open a published app | The app shared with one of your roles, or **Mini apps** Read. Dashboard apps also need **Companion** or **Mini apps** Read, because they open in Companion. |
| Build an app, or change one with Companion | **Mini apps** Write and **Companion** Write. If the app has an editor list, you must be on it or be its owner. |
| Publish, unpublish or delete an app | Edit access to the app. Publishing also needs every permission the app uses. |
| Change which roles can open an app | **Roles settings** Write and edit access to the app |
| Pin apps under **Reports & Apps**, or place widgets with **Adjust widgets** | **Helpdesk settings** Write |

A role with **Full admin access** holds every permission, but an app's editor list restricts admins too. See [Control who can edit](https://docs.open.cx/apps/share-and-use.md#control-who-can-edit).

> [!NOTE]
>
> The **Builds mini apps** row under **Settings → Advanced** is a separate AI agent capability, available on request. Building apps with Companion in the dashboard doesn't depend on it, only on the role permissions above.

Creating, publishing, sharing and deleting an app, and changes to its editors, appear in [Audit logs](https://docs.open.cx/security/audit-logs.md).

***

## Related Documentation

> [card] [Build and publish](https://docs.open.cx/apps/build-and-publish.md)
>
> Create, preview, publish and roll back an app.

> [card] [Share and use](https://docs.open.cx/apps/share-and-use.md)
>
> Roles, editors, Reports & Apps and inbox widgets.

> [card] [Permissions reference](https://docs.open.cx/security/permissions-reference.md)
>
> What each role permission allows.

> [card] [Actions](https://docs.open.cx/actions/introduction.md)
>
> Connect your systems for apps to use.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.