Sendgrid – WOLFX

You can use the SendGrid (opens in a new tab) provider to send transactional emails to your customers using the Wolfx Platform with a single API to create multi-channel experiences.

Getting Started

To use the Sendgrid provider in the email channel, you will need to create a Sendgrid account and add your API key to the SendGrid integration on the Wolfx platform.

Generating an API Key

To generate a new API key in SendGrid, follow these steps:

Log in to your SendGrid account.
Click on the Settings gear icon in the top right corner of the screen, and then click "API Keys" from the drop-down menu.
On the API Keys page, click the Create API Key button.
Give the API key a name and select the following permissions
Mail Send - Full Access
(Optional) Template Engine - Read Only
Click the Create & View button to generate the API key. The key will be displayed on the screen, but you will only be able to view it once, so make sure to save it in a safe place.

NOTE

The access level of the key will determine what actions the API Key can take, so please choose the correct one.

Mail Send - Full Access
(Optional) Template Engine - Read Only

Authenticating your Sender Identity (opens in a new tab)

Before you can send emails on a large scale, you will need to authenticate your Sender Identity. This is due to the latest regulatory changes regarding SPAM rules and email fraud. Most of the providers including Sendgrid require you to authenticate your Sender Identity before you can send emails.

SendGrid allows you to authenticate your sender identity using one of the following methods:

Single Sender Verification (opens in a new tab) - This is the easiest way to authenticate your sender identity.
Entire Domain Authentication (opens in a new tab) - This is recommended if you are sending emails from multiple accounts under your domain.

SendGrid integration with Wolfx

Visit the Integrations store (opens in a new tab) on the Wolfx web dashboard.
Click on Add a Provider.
Select SendGrid service.
Enter your SendGrid API Key.
Fill in the From email address field using the authenticated email from the previous step.
Click on the Disabled button and mark it as Active.
Click on the Update button.
You should now be able to send notifications through SendGrid using Wolfx.

Using SendGrid template

Wolfx has its own email editor for writing email template. If you want to use pre made template from SendGrid, you can use customData filed of email overrides to send template details. Make sure your Api Key has enough permission to read and process the template.

customData override is available from version 0.21.0

import { Wolfx } from '@novu/node';
 
const novu = new Wolfx('<WOLFX_API_KEY>');
 
await novu.subscribers.trigger("workflowIdentifier", {
  to: "subscriberId",
  payload: {},
  overrides: {
  email: {
  customData: {
  // sendgrid template templateId
  templateId: 'sendgrid-template-id',
  // sendgrid template variables
  dynamicTemplateData: {
  total: '$ 239.85',
  items: [{
  text: 'New Line Sneakers',
  image: 'https://marketing-image-production.s3.amazonaws.com/uploads/8dda1131320a6d978b515cc04ed479df259a458d5d45d58b6b381cae0bf9588113e80ef912f69e8c4cc1ef1a0297e8eefdb7b270064cc046b79a44e21b811802.png',
  price: '$ 79.95',
},
{
  text: 'Old Line Sneakers rlfjrjrh4hr4rh4',
  image: 'https://marketing-image-production.s3.amazonaws.com/uploads/3629f54390ead663d4eb7c53702e492de63299d7c5f7239efdc693b09b9b28c82c924225dcd8dcb65732d5ca7b7b753c5f17e056405bbd4596e4e63a96ae5018.png',
  price: '$ 79.95',
},
  ],
  receipt: true,
  name: 'Sample Name',
  address01: '1234 Fake St.',
  address02: 'Apt. 123',
  city: 'Place',
  state: 'CO',
  zip: '80202',
},
},
}
},
  // actorId is subscriberId of actor
  actor: "actorId"
  tenant: "tenantIdentifier"
});

Resend Sendinblue