Skip to main content

@nestjs-mod/webhook

Webhook module with an error filter, guard, controller, database migrations and rest-sdk for work with module from other nodejs appliaction

NPM version monthly downloads Telegram Discord

Installation

npm i --save @nestjs-mod/webhook

Modules

LinkCategoryDescription
WebhookModulefeatureWebhook module with an error filter, guard, controller, database migrations and rest-sdk for work with module from other nodejs appliaction

Modules descriptions

WebhookModule

Webhook module with an error filter, guard, controller, database migrations and rest-sdk for work with module from other nodejs appliaction

Shared providers

WebhookService, WebhookUsersService

Shared imports

HttpModule, PrismaModule

Configuration

KeyDescriptionConstraintsDefaultValue
eventsList of available eventsoptional--
syncModeWhen we run an application in a serverless environment, our background tasks do not have time to complete, to disable background tasks and process requests on demand, we need to switch this property to trueoptionalfalse-

Static environments

KeyDescriptionSourcesConstraintsDefaultValue
useGuardsUse guardsobj['useGuards'], process.env['WEBHOOK_USE_GUARDS']optionaltruetrue
useFiltersUse filtersobj['useFilters'], process.env['WEBHOOK_USE_FILTERS']optionaltruetrue
autoCreateUserAuto create user from guardobj['autoCreateUser'], process.env['WEBHOOK_AUTO_CREATE_USER']optionaltruetrue
skipGuardErrorsSkip any guard errorsobj['skipGuardErrors'], process.env['WEBHOOK_SKIP_GUARD_ERRORS']optionalfalsefalse
cacheTTLTTL for cached dataobj['cacheTTL'], process.env['WEBHOOK_CACHE_TTL']optional1500015000

Static configuration

KeyDescriptionConstraintsDefaultValue
guardsExternal guards for controllersoptional--
mutateControllerFunction for additional mutation of controllersoptional--

Feature configuration

KeyDescriptionConstraintsDefaultValue
eventsList of available eventsoptional--

Back to Top

License

MIT