Skip to main content

Adding flows to domains

Adding flows to your domains helps document which business processes or workflows belong to a particular domain.

When adding flows to your domain EventCatalog will:

  • Show the flows in the domain sidebar
  • Create clear relationships between domains and the processes they contain

Adding flows using frontmatter​

To add flows to a domain you need to add them to the flows array within your domain frontmatter API.

/domains/Orders/index.mdx (example)
---
id: OrdersDomain
... # other domain frontmatter
flows:
    # id of the flow you want to add
    - id: OrderProcessing
    # (optional) The version of the flow you want to add.
      version: 1.0.0

    # Note: version is optional. If no version is given the latest version of the flow will be used.
    - id: PaymentFlow
---

<!-- Markdown content... -->

The flows frontmatter in your domain tells EventCatalog that these documented flows belong to this domain.

In the example above we can see that the flows OrderProcessing and PaymentFlow belong to the OrdersDomain.