Class WebhooksResource

deliveries

• deliveries(
      options?: {
          event?: string;
          status?: "all" | "pending" | "success" | "failed";
          limit?: number;
          offset?: number;
      },
  ): Promise<WebhookDeliveriesResult>

  List recent webhook delivery attempts.

  Parameters

  • Optionaloptions: {
        event?: string;
        status?: "all" | "pending" | "success" | "failed";
        limit?: number;
        offset?: number;
    }

    Optional filters and pagination.

    • Optionalevent?: string

      Filter by event type (e.g. 'rating.updated').

    • Optionalstatus?: "all" | "pending" | "success" | "failed"

      Filter: 'all', 'pending', 'success', or 'failed'.

    • Optionallimit?: number

      Results per page (1-100, default 20).

    • Optionaloffset?: number

      Pagination offset.

  Returns Promise<WebhookDeliveriesResult>

  WebhookDeliveriesResult with entries and total.

  Example

  const result = await client.webhooks.deliveries({ status: 'failed' });
  for (const d of result.deliveries) {
    console.log(d.event, d.statusCode, d.errorMessage);
  }
  Copy