@dialstack/sdk-dev / server/src / WebhookEndpoint
Interface: WebhookEndpoint
Defined in: sdk/server/src/index.ts:362
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.
Endpoints are platform-global by default (they receive every account's events
for their mode). To manage a single account's scoped endpoints instead, set
dialstackAccount (the DialStack-Account header) on the client or request;
that account's events are then delivered to its scoped endpoints in addition
to the platform-global ones.
Properties
created_at
created_at: string;
Defined in: sdk/server/src/index.ts:372
description
description: string | null;
Defined in: sdk/server/src/index.ts:369
enabled_events
enabled_events: string[];
Defined in: sdk/server/src/index.ts:367
Subscribed event types, or ["*"] for all events.
id
id: string;
Defined in: sdk/server/src/index.ts:363
livemode
livemode: boolean;
Defined in: sdk/server/src/index.ts:365
secret?
optional secret?: string;
Defined in: sdk/server/src/index.ts:371
Present only on the create response. Store it to verify signatures.
status
status: "disabled" | "enabled";
Defined in: sdk/server/src/index.ts:368
url
url: string;
Defined in: sdk/server/src/index.ts:364