> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/developer-guides/overview.md).

# Overview

Build on Mimeeq with embeds, events and APIs. Learn what the developer documentation covers and where to start for your integration.

We have created a special place for the developer documentation, which can be found at <https://docs.mimeeq.com/>. It is written for developers and integration partners who embed the configurator on a website, customise how it looks and behaves, or connect Mimeeq to other business systems.

This Help Centre focuses on using the Mimeeq app. Use the articles in this section for the setup you do in the admin panel, and the developer documentation for code examples, endpoints and technical reference.

<a href="https://docs.mimeeq.com/" class="button secondary" data-icon="arrow-up-right">Open developer documentation</a>

***

## What the developer documentation covers

<table><thead><tr><th width="60">#</th><th>Topic</th><th>What it covers</th></tr></thead><tbody><tr><td>1</td><td><strong>Embed types</strong></td><td>Embeddable configurators, including standard, modular, product list and basket experiences.</td></tr><tr><td>2</td><td><strong>Web Components</strong></td><td>Ready-made components such as the embed and authentication tags for simpler integration.</td></tr><tr><td>3</td><td><strong>Events</strong></td><td>Events you can listen to when users take actions or change their configuration.</td></tr><tr><td>4</td><td><strong>JavaScript API</strong></td><td>Programmatic control of the configurator and end-user authentication from your own code.</td></tr><tr><td>5</td><td><strong>Data observables</strong></td><td>Real-time subscriptions to configuration and pricing changes.</td></tr><tr><td>6</td><td><strong>Customisation</strong></td><td>Translations, CSS variables and fully bespoke configurator experiences.</td></tr><tr><td>7</td><td><strong>End-user authentication</strong></td><td>Sign-in, password recovery and profile management for your customers.</td></tr><tr><td>8</td><td><strong>Admin API</strong></td><td>Server-side access for managing catalogue, pricing, companies and quotations.</td></tr><tr><td>9</td><td><strong>Embed API</strong></td><td>Configured product details and pricing data for downstream systems.</td></tr><tr><td>10</td><td><strong>Webhooks</strong></td><td>Event notifications for server-side integrations.</td></tr></tbody></table>

***

## Where to start

* **Embed a configurator on your website:** start with embed types and Web Components in the developer documentation.
* **Build your own interface:** read the [Custom UI](/developer-guides/custom-ui.md) guide, then the JavaScript API and data observables.
* **Track how customers use the configurator:** see [Events & Tracking](/developer-guides/events-and-tracking.md) and the events list in the developer documentation.
* **Sync data with an ERP, CRM or e-commerce platform:** create a key as described in [API Keys](/developer-guides/api-keys.md), then use the Admin API reference.
* **Get notified when something happens in Mimeeq:** set up [Webhooks](/developer-guides/webhooks.md) in the app.

{% hint style="info" %}
Most integrations need an API key. You can create and manage keys in the Mimeeq app under **Settings → Customer settings → API Management**.
{% endhint %}

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>API Keys</strong></td><td>What the Embed API and Admin API do, how to generate a key and how to monitor API requests.</td><td><a href="/developer-guides/api-keys.md">API Keys</a></td></tr><tr><td><strong>Custom UI</strong></td><td>Build and deploy your own interface for the Mimeeq 3D configurator.</td><td><a href="/developer-guides/custom-ui.md">Custom UI</a></td></tr><tr><td><strong>Webhooks</strong></td><td>Create and test webhooks to receive Mimeeq events in real time.</td><td><a href="/developer-guides/webhooks.md">Webhooks</a></td></tr><tr><td><strong>Events &#x26; Tracking</strong></td><td>Use Mimeeq events to build your own custom analytics.</td><td><a href="/developer-guides/events-and-tracking.md">Events &amp; Tracking</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/developer-guides/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.