Class WebhookDeliveriesClient

Delivery history for a single webhook endpoint.

Index

Constructors

Methods

Constructors

constructor

new WebhookDeliveriesClient(
options: WebhookDeliveriesClientOptions,
): WebhookDeliveriesClient
Parameters
- options: WebhookDeliveriesClientOptions
  The underlying admin client and deliveries path.
Returns WebhookDeliveriesClient
- Defined in webhook-endpoints/client.ts:144

Methods

list

list(options?: ListOptions): Promise<Paged<WebhookDelivery>>
Lists delivery attempts.
Parameters
- options: ListOptions = {}
  Optional pagination and cancellation signal.
Returns Promise<Paged<WebhookDelivery>>
A lazily paginating collection of deliveries.

Throws
ApiException When the control plane returns a non-success status.
- Defined in webhook-endpoints/client.ts:158