@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias EventDoc

    The only hand-authored part of the published webhook page. Everything else — the event name, the entity scopes, every field and enum member of data — is derived from the registry, so it cannot drift.

    type EventDoc = {
        hiddenReason?: string;
        notes?: string;
        references: readonly EventDocReference[];
        summary: string;
    }
    Index
    hiddenReason?: string

    Withhold this event from the published page, and say why.

    A reason string rather than a boolean, and a field on the doc rather than a separate exclusion list: an event still needs a full entry to be hidden, so hiding can never become the cheap way to avoid documenting something. The event keeps being published on the bus either way — this only governs what docs.cfx.to shows.

    notes?: string

    Anything a consumer needs that the payload schema cannot express.

    references: readonly EventDocReference[]

    The GET operation a consumer should call to read the object's latest state. Empty when the event refers to no addressable REST resource.

    summary: string

    One sentence, present perfect: what has just happened when this fires.