Skip to main content

Message channels reference

View as Markdown

This page lists the fields, paths, and routes supported by channels.

Paths​

Channels can be created in any channels folder:

/channels/{Channel Name}/index.mdx
/domains/{Domain Name}/channels/{Channel Name}/index.mdx
/services/{Service Name}/channels/{Channel Name}/index.mdx

Versioned channels use:

/channels/{Channel Name}/versioned/{version}/index.mdx

Routes​

RouteDescription
/docs/channels/{channel-id}/{version}Channel documentation page.
/visualiser/channels/{channel-id}/{version}Channel resource diagram.

Required fields​

id​

  • Type: string

Unique id of the channel. EventCatalog uses this for URLs and resource references.

Example
---
id: orders-topic
---

name​

  • Type: string

Display name of the channel.

Example
---
name: Orders Topic
---

version​

  • Type: string

Version of the channel documentation.

Example
---
version: 1.0.0
---

Optional fields​

summary​

  • Type: string

Short description of the channel.

Example
---
summary: Kafka topic that carries ordering events.
---

owners​

  • Type: array

An array of team or user ids that own the channel.

Example
---
owners:
  - ordering-platform
---

address​

  • Type: string

Broker address, topic, stream, queue, or route.

Example
---
address: orders.events
---

protocols​

  • Type: array

Protocols used by the channel, such as Kafka, HTTP, or AMQP.

Example
---
protocols:
  - kafka
---

deliveryGuarantee​

  • Type: at-most-once, at-least-once, or exactly-once

Delivery guarantee for messages on the channel.

Example
---
deliveryGuarantee: at-least-once
---

parameters​

  • Type: object

Parameter definitions for templated channel addresses.

Example
---
parameters:
  region:
    description: Deployment region for the topic.
---

badges​

  • Type: array

Badges rendered on the channel page.

Example
---
badges:
  - content: Kafka
    backgroundColor: purple
    textColor: purple
---

Delivery guarantee​

Use deliveryGuarantee to describe how messages are delivered on the channel.

Supported values are at-most-once, at-least-once, and exactly-once.

---
deliveryGuarantee: at-least-once
---

Custom properties​

You can add organization-specific metadata to this resource using frontmatter fields prefixed with x-. Learn how to define, render, and reference them in Custom properties on resources.