Class Webhook

constructor

• new Webhook(auth?, options?): Webhook

• Parameters

  • Optional auth: string

  • options: WebhookOptions = {}

  Returns Webhook

options

hookListener

• hookListener(fn): ((req, res, next) => Promise<void>)

• Parameters

  • fn: ((payload, req?, res?, next?) => void | Promise<void>)

    • • (payload, req?, res?, next?): void | Promise<void>

      • Parameters

        • payload: WebhookPayload

        • Optional req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

        • Optional res: Response<any, Record<string, any>>

        • Optional next: NextFunction

        Returns void | Promise<void>

  Returns ((req, res, next) => Promise<void>)

  • • (req, res, next): Promise<void>

    • Parameters

      • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      • res: Response<any, Record<string, any>>

      • next: NextFunction

      Returns Promise<void>

middleware

• middleware(): ((req, res, next) => Promise<void>)

• Returns ((req, res, next) => Promise<void>)

  • • (req, res, next): Promise<void>

    • Parameters

      • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      • res: Response<any, Record<string, any>>

      • next: NextFunction

      Returns Promise<void>