Skip to main content

Adding flows to services

Adding flows to your services helps document which business processes or workflows involve a particular service.

When adding flows to your service EventCatalog will:

  • Show the flows in the service sidebar
  • Create clear relationships between services and the processes they participate in

Adding flows using frontmatter​

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

/services/Orders/index.mdx (example)
---
id: OrdersService
... # other service 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 service tells EventCatalog that these documented flows involve this service.

In the example above we can see that the flows OrderProcessing and PaymentFlow involve the OrdersService.