Interface ApiWebhookProps

Props accepted by ApiWebhook.

interface ApiWebhookProps {
    onDiagnostic?: DiagnosticSink;
    strict?: boolean;
    schema: unknown;
    name: string;
    widgets?: WidgetMap;
    meta?: SchemaMeta;
}

Hierarchy (View Summary)

ApiDiagnosticsProps
- ApiWebhookProps

Index

Properties

onDiagnostic? strict? schema name widgets? meta?

Properties

`Optional`onDiagnostic

onDiagnostic?: DiagnosticSink

`Optional`strict

strict?: boolean

schema

schema: unknown

name

name: string

Webhook name (key under the document's webhooks map).

`Optional`widgets

widgets?: WidgetMap

Instance-scoped widgets, forwarded to each rendered operation.

`Optional`meta

meta?: SchemaMeta