Skip to content

Function: getWebhookStatistics() ​

ts
function getWebhookStatistics(
   client, 
   parameters, 
   options?
): Promise<{
[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:119

Returns how a webhook has been delivering. Requires administrator permission.

Parameters ​

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

Returns ​

Promise<{ [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>; }>