Skip to main content

Event Frontmatter Config

Overview​

Events are just markdown files, with this comes the use of Content, MDX components and also front-matter.

Here is an example of the event frontmatter you will find in your event files.

---
name: EmailSent
version: 0.6.1
summary: |
  Tells us when an email has been sent
producers:
    - Email Platform
owners:
    - dboyne
    - mSmith
---

Required fields​

name​

  • Type: string

Name of the event.

Example
---
  name: EmailSent
---

version​

  • Type: string

The version of your event.

Example
---
  version: 0.0.1
---
tip

You can version your events and use EventCatalog to see previous events and changelogs for events. Check out XXX for more information.

Optional fields​

summary​

Short summary of your event, shown on event summary pages.

Example
---
  summary: |
    Tells us when an email has been sent
---

producers​

An array of services that produce the event.

Example
---
  producers:
    - Email Platform
    - User Service
    - Internal API
---

consumers​

An array of services that consume/subscribe the event.

Example
---
  consumers:
    - Email Platform
    - User Service
---

owners​

An array of user ids that own the event.

Example
---
  owners:
    - dboyne
    - mSmith
---
How to configure users

You can configure users in the eventcatalog.config.js file. Find out more reading the users configuration

List of URLs that can be used when people want to reference to external documentation.

  • Type: Tag
    • label: value that gets rendered on the UI
    • href: URL for link
Example
---
  externalLinks:
    - label: AsyncAPI Specification
      url: https://studio.asyncapi.com/#schema-lightMeasuredPayload
---

tags​

List of tags related to the event.

  • Type: Tag
    • label: value that gets rendered on the UI
    • href: URL for link (optional)
Example
---
  tags:
    - label: 'Topic: order-requested'
    - label: 'Broker: kafka'
      url: https://kafka.apache.org
---