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.

Open developer documentation

---

What the developer documentation covers

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

---

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 guide, then the JavaScript API and data observables.

• Track how customers use the configurator: see Events & Tracking 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, then use the Admin API reference.

• Get notified when something happens in Mimeeq: set up Webhooks in the app.

Most integrations need an API key. You can create and manage keys in the Mimeeq app under Settings → Customer settings → API Management.

---

Related articles

API Keys

What the Embed API and Admin API do, how to generate a key and how to monitor API requests.

Custom UI

Build and deploy your own interface for the Mimeeq 3D configurator.

Webhooks

Create and test webhooks to receive Mimeeq events in real time.

Events & Tracking

Use Mimeeq events to build your own custom analytics.