Interface WebhookDef<Name, Events>

Provider-neutral webhook definition.

interface WebhookDef<
    Name extends string = string,
    Events extends WebhookEventSchemas = WebhookEventSchemas,
> {
    events: Events;
    kind: "webhook";
    metadata?: Record<string, unknown>;
    name: Name;
    provider?: string;
    verifier?: WebhookVerifier<WebhookEvent<unknown>>;
}

Type Parameters

Name extends string = string
Events extends WebhookEventSchemas = WebhookEventSchemas

Index

Properties

events kind metadata? name provider? verifier?

Properties

events

events: Events

kind

kind: "webhook"

`Optional`metadata

metadata?: Record<string, unknown>

name

name: Name

`Optional`provider

provider?: string

`Optional`verifier

verifier?: WebhookVerifier<WebhookEvent<unknown>>