Class WebhooksNamespace

Index

Methods

create delete get list update

Methods

create

create(params: CreateWebhookRequest): Promise<CreateWebhookResponse>
POST /api/webhooks — Create a webhook subscription.
Parameters
- params: CreateWebhookRequest
Returns Promise<CreateWebhookResponse>
- Defined in src/core/namespaces/webhooks.ts:27

delete

delete(webhookId: string): Promise<{ deleted: string; ok: boolean }>
DELETE /api/webhooks/:id — Delete a webhook subscription.
Parameters
- webhookId: string
Returns Promise<{ deleted: string; ok: boolean }>
- Defined in src/core/namespaces/webhooks.ts:42

get

get(webhookId: string): Promise<{ subscription: WebhookSubscription }>
GET /api/webhooks/:id — Get a single webhook subscription.
Parameters
- webhookId: string
Returns Promise<{ subscription: WebhookSubscription }>
- Defined in src/core/namespaces/webhooks.ts:32

list

list(): Promise<{ subscriptions: WebhookSubscription[] }>
GET /api/webhooks — List webhook subscriptions.

Returns Promise<{ subscriptions: WebhookSubscription[] }>
- Defined in src/core/namespaces/webhooks.ts:22

update

update(
webhookId: string,
action: "pause" | "resume",
): Promise<Record<string, unknown>>
PATCH /api/webhooks/:id — Update a webhook (pause/resume).
Parameters
- webhookId: string
- action: "pause" | "resume"
Returns Promise<Record<string, unknown>>
- Defined in src/core/namespaces/webhooks.ts:37