Class WebhooksResource

Webhook registration and management.

Index

Constructors

Methods

list register remove

Constructors

constructor

new WebhooksResource(http: BaseClient): WebhooksResource
Parameters
- http: BaseClient
Returns WebhooksResource
- Defined in src/resources/webhooks.ts:14

Methods

list

list(): Promise<ShardWebhooksResponse>
Lists all registered webhooks.

Returns Promise<ShardWebhooksResponse>
- Defined in src/resources/webhooks.ts:19

register

register(
    url: string,
    events: string[],
    secret?: string,
): Promise<ShardWebhookRegisterResponse>
Registers a new webhook for shard events.
Parameters
- url: string
  Webhook delivery URL.
- events: string[]
  Array of event types to subscribe to.
- Optionalsecret: string
  Optional shared secret for webhook signature verification.
Returns Promise<ShardWebhookRegisterResponse>
The created webhook entry and its generated secret.
- Defined in src/resources/webhooks.ts:30

remove

remove(id: string): Promise<ShardWebhookRemoveResponse>
Removes a registered webhook.
Parameters
- id: string
  Webhook ID to remove.
Returns Promise<ShardWebhookRemoveResponse>
- Defined in src/resources/webhooks.ts:42