Teams reference
This page lists the fields and paths supported by teams.
Paths
Teams are created in the teams folder:
/teams/{team-id}.mdx
Teams can also be synced from directory sources such as GitHub or Microsoft Entra.
Routes
| Route | Description |
|---|---|
/docs/teams/{team-id} | Team overview page. |
/docs/teams/{team-id}/resources | Everything the team owns, in a searchable table. Only created when the team owns at least one resource. (Added in 5.12.0) |
The Owned Resources table can be opened filtered to resource types with the type query parameter, for example /docs/teams/payments-platform/resources?type=events,commands,queries.
Required fields
id
- Type:
string
Unique id of the team. EventCatalog uses this for URLs and resource references.
Example
---
id: payments-platform
---
name
- Type:
string
Display name of the team.
Example
---
name: Payments Platform
---
Optional fields
summary
- Type:
string
Short description of the team.
Example
---
summary: Owns payment processing and refund workflows.
---
email
- Type:
string
Team email address.
Example
---
email: payments@example.com
---
slackDirectMessageUrl
- Type:
string
Slack URL for contacting the team.
Example
---
slackDirectMessageUrl: https://slack.example.com/team/payments
---
msTeamsDirectMessageUrl
- Type:
string
Microsoft Teams URL for contacting the team.
Example
---
msTeamsDirectMessageUrl: https://teams.microsoft.com/l/channel/example
---
members
- Type:
array
Users that belong to the team.
Example
---
members:
- dboyne
---
Example
---
id: payments-platform
name: Payments Platform
summary: Owns payment processing and refund workflows.
members:
- dboyne
ownedServices:
- payment-api
ownedEvents:
- PaymentAuthorized
---