API Key does not start with "SG." SendGrid

Question

I am trying to set up SendGrid add-on in my Heroku NodeJS app. I created the API Key and set it as an environment variable.

The whole API key looks something like: SG.actualValue.bbb_cccccc

The first setup I did I set the whole key as as my SENDGRID_API_KEY and I got this error:

API key does not start with SG.

So, I realized the mistake and unset the environment variable and set it again only to the actualValue part of the whole key.

However, I still get the same error. I tried doing the same thing again or restarting the terminal(actually, whole laptop).

This is the test code I am trying to run from the SendGrid setup page:

const sgMail = require('@sendgrid/mail');
sgMail.setApiKey(process.env.SENDGRID_API_KEY)
const msg = {
  to: '[email protected]',
  from: '[email protected]',
  subject: 'Sending with Twilio SendGrid is Fun',
  text: 'and easy to do anywhere, even with Node.js',
  html: '<strong>and easy to do anywhere, even with Node.js</strong>',
};
sgMail.send(msg);

I tried creating a new key and setting it, but I get the same error. I tried setting it to the whole key, but without ".SG" or just the bbb_ccccc part. Thank you in advance.

Solution 1

API key does not start with SG.

means the API key of SendGrid SHOULD start with SG. So you didn't set the environment variables correctly. You need to check it. Just use console.log print the environment variables. Or, use

$ heroku run bash -a mighty-river-12802

to start a console for your app, and use printenv to print the environment variables.

Running bash on ⬢ mighty-river-12802... up, run.1571 (Free)
~ $ printenv
TERM=xterm-256color
WEB_MEMORY=512
MEMORY_AVAILABLE=512
COLUMNS=367
DYNO=run.1571
PATH=/app/.heroku/node/bin:/app/.heroku/yarn/bin:/usr/local/bin:/usr/bin:/bin:/app/bin:/app/node_modules/.bin
WEB_CONCURRENCY=1
_=/usr/bin/printenv
PWD=/app
PS1=\[\033[01;34m\]\w\[\033[00m\] \[\033[01;32m\]$ \[\033[00m\]
NODE_ENV=production
LINES=49
TIMES=5
HOME=/app
SHLVL=2
PORT=6791
NODE_HOME=/app/.heroku/node

TIMES: 5 environment variable is set via heroku config vars:

E.g.

const sgMail = require('@sendgrid/mail');

sgMail.setApiKey(process.env.SENDGRID_API_KEY);
const msg = {
  to: '[email protected]',
  from: '[email protected]',
  subject: 'Sending with Twilio SendGrid is Fun',
  text: 'and easy to do anywhere, even with Node.js',
  html: '<strong>and easy to do anywhere, even with Node.js</strong>',
};
sgMail
  .send(msg)
  .then(() => console.log('send mail success'))
  .catch(console.log);

$ export SENDGRID_API_KEY=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
$ node index.js
send mail success

Received the email as expected:

Solution 2

hello there If you are using node js, make sure you have the require('dotenv').config() inside the file that needs the sendgrid/nodemailer module. Without it, the sendgrid transporter will have an undefined value instead of the api_key. i also encountered the same issue and its solved.

Solution 3

I'm using SendGrids v3 and dotenv v8.2, on Node.js SendGrid set up an env file SendGrid.env, inside it has export SENDGRID_API_KEY, I renamed the file to .env, removed export and now it works.

At top of my sendEmail file looks like this:

require('dotenv').config();
const sgMail = require('@sendgrid/mail');
const apiKey = `${process.env.SENDGRID_API_KEY}`;
console.log("SendGrid key ", apiKey);

my .env file looks like this:

SENDGRID_API_KEY='SG.{left blank}................0EmA'
ANOTHER_API_KEY='ANOTEHERKEY'

Solution 4

I changed the single quote to double quote in .env. That fixed my bug. Here is how my sendgrid.env file looks like:

SENDGRID_API_KEY = "SG.oDXKOMdlT3-nCEQt........"

Solution 5

You need to require('dotenv').config(); at the beginning of your test file, otherwise it won't be able to find your key.

View more solutions

Comments

[monsto]

This did it for me. It's the simple things.

[trsp]

Thank you! It worked for me, i was not using dotenv.

[Ufenei augustine]

environment variables for production should be set on the server so do not need the dotenv. dotenv is for development not production

[Johar Zaman]

dotenv.config(); must be called before sgMail.setApiKey(process.env.SENDGRID_API_KEY);