fix: add custom header support for resend, brevo and sendgrid (#5343)

Co-authored-by: Dima Grossman <[email protected]>
novuhq · Apr 29, 2024 · b1920de · b1920de
1 parent f806e83
commit b1920de
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 1 deletion.
diff --git a/apps/worker/src/app/workflow/usecases/send-message/send-message-email.usecase.ts b/apps/worker/src/app/workflow/usecases/send-message/send-message-email.usecase.ts
@@ -537,6 +537,7 @@ export const createMailData = (options: IEmailOptions, overrides: Record<string,
  senderName: overrides?.senderName || options.senderName,
  subject: overrides?.subject || options.subject,
  customData: overrides?.customData || {},
+ headers: overrides?.headers || {},
  };
 };
 

diff --git a/libs/shared/src/types/events/index.ts b/libs/shared/src/types/events/index.ts
@@ -36,6 +36,7 @@ export interface IEmailOptions {
  notificationDetails?: any;
  ipPoolName?: string;
  customData?: Record<string, any>;
+ headers?: Record<string, string>;
  senderName?: string;
 }
 

diff --git a/packages/node/README.md b/packages/node/README.md
@@ -541,7 +541,10 @@ await novu.events.trigger("workflowIdentifier", {
  // customData will work only for sendgrid
  customData: {
  "customKey": "customValue"
- }
+ },
+ headers: {
+ 'X-Novu-Custom-Header': 'Novu-Custom-Header-Value',
+ },
  }
  },
  // actorId is subscriberId of actor

diff --git a/packages/node/src/lib/events/events.interface.ts b/packages/node/src/lib/events/events.interface.ts
@@ -37,6 +37,7 @@ export interface IEmailOverrides extends IIntegrationOverride {
  bcc?: string[];
  senderName?: string;
  customData?: Record<string, any>;
+ headers?: Record<string, string>;
 }
 
 export type ITriggerTenant = string | ITenantDefine;

diff --git a/packages/node/src/lib/events/events.spec.ts b/packages/node/src/lib/events/events.spec.ts
@@ -114,6 +114,9 @@ describe('test use of novus node package - Events', () => {
  name: 'Fourth Child',
  },
  },
+ headers: {
+ 'X-Novu-Custom-Header': 'test-data',
+ },
  },
  },
  payload: {

diff --git a/packages/stateless/src/lib/provider/provider.interface.ts b/packages/stateless/src/lib/provider/provider.interface.ts
@@ -24,6 +24,7 @@ export interface IEmailOptions {
  notificationDetails?: any;
  ipPoolName?: string;
  customData?: Record<string, any>;
+ headers?: Record<string, string>;
  senderName?: string;
 }
 

diff --git a/providers/resend/src/lib/resend.provider.ts b/providers/resend/src/lib/resend.provider.ts
@@ -42,6 +42,7 @@ export class ResendEmailProvider implements IEmailProvider {
  content: attachment.file,
  })),
  bcc: options.bcc,
+ headers: options.headers,
  });
 
  if (response.error) {

diff --git a/providers/sendgrid/src/lib/sendgrid.provider.ts b/providers/sendgrid/src/lib/sendgrid.provider.ts
@@ -128,6 +128,7 @@ export class SendgridEmailProvider implements IEmailProvider {
  },
  ],
  templateId: templateId,
+ headers: options.headers,
  };
 
  if (options.replyTo) {

diff --git a/providers/sendinblue/src/lib/brevo.provider.ts b/providers/sendinblue/src/lib/brevo.provider.ts
@@ -47,6 +47,7 @@ export class BrevoEmailProvider implements IEmailProvider {
  name: attachment?.name,
  content: attachment?.file.toString('base64'),
  }));
+ email.headers = options.headers;
 
  if (options.cc?.length) {
  email.cc = options.cc?.map((ccItem) => ({ email: ccItem }));