Interface WebhookEvent<T>

A verified webhook event. Its type identifies which event occurred.

interface WebhookEvent<T = Record<string, unknown>> {
    data: T;
    type: KnownWebhookType;
    webhookType: KnownWebhookType;
    [key: string]: unknown;
}

Type Parameters

T = Record<string, unknown>

Indexable

[key: string]: unknown

Index

Properties

data type webhookType

Properties

data

data: T

The event payload.

type

type: KnownWebhookType

The event type (e.g. "recording-stopped").

webhookType

webhookType: KnownWebhookType

Alias of WebhookEvent.type.