Type Alias EventTopic

One subscribable event, as GET /v1/events/topics describes it.

type EventTopic = {
    name: string;
    notes: string | null;
    payloadSchema: TSchema;
    scopes: readonly EventScope[];
    summary: string;
}

Index

Properties

name notes payloadSchema scopes summary

Properties

name

name: string

notes

notes: string | null

payloadSchema

payloadSchema: TSchema

JSON Schema of the delivered payload. TypeBox's ~kind markers are non-enumerable, so JSON drops them.

scopes

scopes: readonly EventScope[]

summary

summary: string