Interface WebhookClient

Client for managing Helius webhook subscriptions.

interface WebhookClient {
    create(params: CreateWebhookRequest): Promise<Webhook>;
    delete(webhookID: string): Promise<boolean>;
    get(webhookID: string): Promise<Webhook>;
    getAll(): Promise<Webhook[]>;
    toggle(webhookID: string, active: boolean): Promise<Webhook>;
    update(webhookID: string, params: UpdateWebhookRequest): Promise<Webhook>;
}

Index

Methods

create delete get getAll toggle update

Methods

create

create(params: CreateWebhookRequest): Promise<Webhook>
Create a new webhook subscription.
Parameters
- params: CreateWebhookRequest
Returns Promise<Webhook>
- Defined in webhooks/client.ts:10

delete

delete(webhookID: string): Promise<boolean>
Delete a webhook. Returns true on success.
Parameters
- webhookID: string
Returns Promise<boolean>
- Defined in webhooks/client.ts:18

get

get(webhookID: string): Promise<Webhook>
Get a webhook by its ID.
Parameters
- webhookID: string
Returns Promise<Webhook>
- Defined in webhooks/client.ts:12

getAll

getAll(): Promise<Webhook[]>
List all webhooks for the current API key.

Returns Promise<Webhook[]>
- Defined in webhooks/client.ts:14

toggle

toggle(webhookID: string, active: boolean): Promise<Webhook>
Enable or disable a webhook without deleting it. Use this to re-enable auto-disabled webhooks or temporarily pause deliveries.
Parameters
- webhookID: string
- active: boolean
Returns Promise<Webhook>
- Defined in webhooks/client.ts:20

update

update(webhookID: string, params: UpdateWebhookRequest): Promise<Webhook>
Update an existing webhook's configuration.
Parameters
- webhookID: string
- params: UpdateWebhookRequest
Returns Promise<Webhook>
- Defined in webhooks/client.ts:16