Skip to content

Function: getWebhooks() ​

ts
function getWebhooks(
   client, 
   parameters?, 
   options?
): Promise<object[]>;

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

Returns the webhooks registered in this instance. Requires administrator permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ event?: string; limit?: number; start?: number; statistics?: boolean; }-
parameters.event?stringOnly webhooks delivering this event.
parameters.limit?number-
parameters.start?number-
parameters.statistics?booleanInclude delivery statistics with each webhook.
options?RequestOptions-

Returns ​

Promise<object[]>