Skip to main content

@dialstack/sdk / server / WebhookEndpoint

Interface: WebhookEndpoint

Defined in: sdk/src/server/index.ts:196

A webhook endpoint receives event notifications. Endpoints are mode-scoped: an endpoint created with a live key (and livemode: true) only receives events from live accounts; one created with a test key only receives events from sandbox accounts. The signing secret is returned only when the endpoint is created.

Properties​

created_at​

created_at: string;

Defined in: sdk/src/server/index.ts:206

description​

description: string | null;

Defined in: sdk/src/server/index.ts:203

enabled_events​

enabled_events: string[];

Defined in: sdk/src/server/index.ts:201

Subscribed event types, or ["*"] for all events.

id​

id: string;

Defined in: sdk/src/server/index.ts:197

livemode​

livemode: boolean;

Defined in: sdk/src/server/index.ts:199

secret?​

optional secret?: string;

Defined in: sdk/src/server/index.ts:205

Present only on the create response. Store it to verify signatures.

status​

status: "disabled" | "enabled";

Defined in: sdk/src/server/index.ts:202

url​

url: string;

Defined in: sdk/src/server/index.ts:198