novuhq · p-fernandez · May 4, 2023 · Apr 20, 2023 · Apr 20, 2023 · Apr 20, 2023
diff --git a/apps/api/src/app/integrations/dtos/credentials.dto.ts b/apps/api/src/app/integrations/dtos/credentials.dto.ts
@@ -41,4 +41,8 @@ export class CredentialsDto {
   ignoreTls?: boolean;
   @ApiPropertyOptional()
   tlsOptions?: Record<string, unknown>;
+  @ApiPropertyOptional()
+  baseUrl?: string;
+  @ApiPropertyOptional()
+  webhookUrl?: string;
 }
@@ -322,6 +322,8 @@ export interface ICredentials {
   clientId?: string;
   projectName?: string;
   serviceAccount?: string;
+  baseUrl?: string;
+  webhookUrl?: string;
   requireTls?: boolean;
   ignoreTls?: boolean;
   tlsOptions?: Record<string, unknown>;

@@ -185,6 +185,7 @@ export interface ICredentials {
   projectName?: string;
   serviceAccount?: string;
   baseUrl?: string;
+  webhookUrl?: string;
   requireTls?: boolean;
   ignoreTls?: boolean;
   tlsOptions?: Record<string, unknown>;

diff --git a/libs/dal/src/repositories/integration/integration.entity.ts b/libs/dal/src/repositories/integration/integration.entity.ts
@@ -24,6 +24,7 @@ export interface ICredentials {
   projectName?: string;
   serviceAccount?: string;
   baseUrl?: string;
+  webhookUrl?: string;
   ipPoolName?: string;
   requireTls?: boolean;
   ignoreTls?: boolean;

diff --git a/libs/dal/src/repositories/integration/integration.schema.ts b/libs/dal/src/repositories/integration/integration.schema.ts
@@ -38,6 +38,7 @@ const integrationSchema = new Schema<IntegrationDBModel>(
       projectName: Schema.Types.String,
       serviceAccount: Schema.Types.String,
       baseUrl: Schema.Types.String,
+      webhookUrl: Schema.Types.String,
       requireTls: Schema.Types.Boolean,
       ignoreTls: Schema.Types.Boolean,
       tlsOptions: Schema.Types.Mixed,

diff --git a/libs/shared/src/consts/providers/channels/push.ts b/libs/shared/src/consts/providers/channels/push.ts
@@ -1,4 +1,4 @@
-import { apnsConfig, fcmConfig, expoConfig } from '../credentials';
+import { apnsConfig, fcmConfig, expoConfig, pushWebhookConfig } from '../credentials';
 import { PushProviderIdEnum } from '../provider.enum';
 import { IProviderConfig } from '../provider.interface';
 
@@ -30,4 +30,13 @@ export const pushProviders: IProviderConfig[] = [
     logoFileName: { light: 'apns.png', dark: 'apns.png' },
     betaVersion: true,
   },
+  {
+    id: PushProviderIdEnum.PushWebhook,
+    displayName: 'Push Webhook',
+    channel: ChannelTypeEnum.PUSH,
+    credentials: pushWebhookConfig,
+    docReference: 'https://docs.novu.co/channels/push/webhook',
+    logoFileName: { light: 'push-webhook.svg', dark: 'push-webhook.svg' },
+    betaVersion: true,
+  },
 ];
diff --git a/libs/shared/src/consts/providers/credentials/provider-credentials.ts b/libs/shared/src/consts/providers/credentials/provider-credentials.ts
@@ -444,6 +444,24 @@ export const expoConfig: IConfigCredentials[] = [
   ...pushConfigBase,
 ];
 
+export const pushWebhookConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.WebhookUrl,
+    displayName: 'Webhook URL',
+    type: 'string',
+    description: 'the webhook URL to call to trigger push notifications',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.SecretKey,
+    displayName: 'Secret Hmac Key',
+    type: 'string',
+    description: 'the secret used to sign webhooks calls',
+    required: true,
+  },
+  ...pushConfigBase,
+];
+
 export const apnsConfig: IConfigCredentials[] = [
   {
     key: CredentialsKeyEnum.SecretKey,

diff --git a/libs/shared/src/consts/providers/provider.enum.ts b/libs/shared/src/consts/providers/provider.enum.ts
@@ -77,6 +77,7 @@ export enum PushProviderIdEnum {
   FCM = 'fcm',
   APNS = 'apns',
   EXPO = 'expo',
+  PushWebhook = 'push-webhook',
 }
 
 export enum InAppProviderIdEnum {

diff --git a/libs/shared/src/dto/integration/construct-integration.interface.ts b/libs/shared/src/dto/integration/construct-integration.interface.ts
@@ -21,8 +21,10 @@ export interface ICredentialsDto {
   requireTls?: boolean;
   ignoreTls?: boolean;
   tlsOptions?: Record<string, unknown>;
+  webhookUrl?: string;
   redirectUrl?: string;
 }
+
 export interface IConstructIntegrationDto {
   credentials: ICredentialsDto;
 

diff --git a/packages/application-generic/package.json b/packages/application-generic/package.json
@@ -70,6 +70,7 @@
     "@novu/outlook365": "^0.14.0",
     "@novu/plivo": "^0.14.0",
     "@novu/postmark": "^0.14.0",
+    "@novu/push-webhook": "^0.14.0",
     "@novu/resend": "^0.14.0",
     "@novu/sendgrid": "^0.14.0",
     "@novu/sendinblue": "^0.14.0",

diff --git a/packages/application-generic/src/factories/push/handlers/index.ts b/packages/application-generic/src/factories/push/handlers/index.ts
@@ -1,3 +1,4 @@
 export * from './apns.handler';
 export * from './expo.handler';
+export * from './push-webhook.handler';
 export * from './fcm.handler';
diff --git a/packages/application-generic/src/factories/push/handlers/push-webhook.handler.ts b/packages/application-generic/src/factories/push/handlers/push-webhook.handler.ts
@@ -0,0 +1,21 @@
+import { ChannelTypeEnum } from '@novu/shared';
+import { PushWebhookPushProvider } from '@novu/push-webhook';
+import { BasePushHandler } from './base.handler';
+import { ICredentials } from '@novu/dal';
+
+export class PushWebhookHandler extends BasePushHandler {
+  constructor() {
+    super('push-webhook', ChannelTypeEnum.PUSH);
+  }
+
+  buildProvider(credentials: ICredentials) {
+    if (!credentials.webhookUrl || !credentials.secretKey) {
+      throw Error('Config is not valid for push-webhook provider');
+    }
+
+    this.provider = new PushWebhookPushProvider({
+      webhookUrl: credentials.webhookUrl,
+      hmacSecretKey: credentials.secretKey,
+    });
+  }
+}
diff --git a/packages/application-generic/src/factories/push/push.factory.ts b/packages/application-generic/src/factories/push/push.factory.ts
@@ -1,12 +1,18 @@
 import { IntegrationEntity } from '@novu/dal';
 import { IPushFactory, IPushHandler } from './interfaces';
-import { APNSHandler, FCMHandler, ExpoHandler } from './handlers';
+import {
+  APNSHandler,
+  FCMHandler,
+  ExpoHandler,
+  PushWebhookHandler,
+} from './handlers';
 
 export class PushFactory implements IPushFactory {
   handlers: IPushHandler[] = [
     new FCMHandler(),
     new ExpoHandler(),
     new APNSHandler(),
+    new PushWebhookHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/providers/postmark/package.json b/providers/postmark/package.json
@@ -46,7 +46,8 @@
   },
   "dependencies": {
     "@novu/stateless": "^0.14.0",
-    "postmark": "^2.7.8"
+    "postmark": "^2.7.8",
+    "axios": "^1.3.6"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "1.0.2",

diff --git a/providers/push-webhook/.czrc b/providers/push-webhook/.czrc
@@ -0,0 +1,3 @@
+{
+  "path": "cz-conventional-changelog"
+}
diff --git a/providers/push-webhook/.eslintrc.json b/providers/push-webhook/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../../.eslintrc.js"
+}
diff --git a/providers/push-webhook/.gitignore b/providers/push-webhook/.gitignore
@@ -0,0 +1,9 @@
+.idea/*
+.nyc_output
+build
+node_modules
+test
+src/**.js
+coverage
+*.log
+package-lock.json