Skip to content

Function: getWebhookStatisticsSummary() ​

ts
function getWebhookStatisticsSummary(
   client, 
   parameters, 
   options?
): Promise<Record<string, {
[key: string]: unknown;
  counts?: {
   [key: string]: unknown;
     errors?: number;
     failures?: number;
     successes?: number;
     window?: {
      [key: string]: unknown;
        duration?: number;
        start?: number;
     };
  };
  lastError?: Record<string, any>;
}>>;

Defined in: src/server/api/webhooks.ts:135

Returns the delivery statistics of a webhook, one entry per event it delivers. Requires administrator permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ webhookId: number; }-
parameters.webhookIdnumberThe id of the webhook.
options?RequestOptions-

Returns ​

Promise<Record<string, { [key: string]: unknown; counts?: { [key: string]: unknown; errors?: number; failures?: number; successes?: number; window?: { [key: string]: unknown; duration?: number; start?: number; }; }; lastError?: Record<string, any>; }>>