Bring Your Miro Boards to Life in EventCatalog
Many teams turn to Miro to brainstorm, map out, and document their architecture. In the world of event-driven systems, techniques like Event Modeling and Event Storming are especially popular. Now, you can embed your Miro boards directly into your documentation—making it easier to collaborate, share insights with your team, and get more lasting value from your diagrams and workshops.
Introducing the new Miro component — now you can seamlessly embed Miro boards into any EventCatalog page, from domains and services to messages and custom documentation. This makes it easier to bring your architecture diagrams, event modeling, and brainstorming sessions into context, keeping everything in one place and driving better alignment across teams.
How does it work?
EventCatalog supports a range of components you can embed into your documentation.
The <Miro /> component is the latest addition to this list.
To embed a Miro board in your documentation, you can use the following code:
---
#event frontmatter
---
## Event storming session
<Miro boardId="uXjVIHCImos=/" />
Rendered output
The miro component also supports:
- Editing the board live in EventCatalog
- Full screen mode
- Embedding multiple boards
- Loading into a widget on the board
You can read the documentation and props here to get started and start building your own documentation.
Full-Screen Mode for Miro Boards
Need more space to explore your diagrams? Clicking the full-screen icon on an embedded Miro board will open it in a new tab, giving your team a larger canvas to work with. If you have edit permissions, you can collaborate in real time—perfect for live sessions and ongoing updates.
Getting started
To get started update your EventCatalog to the latest version:
npm install @eventcatalog/core@latest
Then start using the new <Miro /> component in your documentation.
Summary
Many teams use Miro to capture architecture decisions, event modeling, and event storming sessions. With our new Miro embedding feature, you can now bring those boards directly into your EventCatalog documentation—making it easier to collaborate, share context, and get more value from your visual workflows.
Check out the docs and props to get started and start enhancing your documentation today.
We’d love to hear your thoughts—feel free to open an issue with any feedback or suggestions.
Our community has grown to over 1,100 members and continues to expand! If you haven’t already, join us on Discord and be part of the conversation.
Excited to see what you build with this new feature!