[!WARNING]

⚠️ A New Version of this SDK is Available

brevo-node v5 is now the actively developed version of this library, built on a modern, unified client architecture.

This v3.x version will continue to receive critical security updates only — no new features will be added. We strongly recommend migrating to the new version at your earliest convenience.

📖 View the Migration Guide →

Overview

Brevo's API exposes the entire Brevo features via a standardized programmatic interface. Please refer to the full documentation to see all the supported operations.

Brevo's API matches the OpenAPI v2 definition. The specification can be downloaded here.

Our current library is not fully compatible with all modern Node.js and TypeScript environments. To help you integrate Brevo into your applications, we're providing both plain Node.js and TypeScript-specific implementation approaches below while we work on the next generation of our SDK.

Table of Contents

• Node.js Implementation
  • Send Transactional Email
  • Create Contact
• TypeScript Implementation
  • Send Transactional Email
  • Create Contact
• Support
• License

Node.js Implementation

Send Transactional Email

Installation

npm i @getbrevo/brevo^3.0.1 --save

Import packages

import { TransactionalEmailsApi, SendSmtpEmail } from "@getbrevo/brevo^3.0.1";

Instantiate API with your credentials

let emailAPI = new TransactionalEmailsApi();
emailAPI.authentications.apiKey.apiKey = "xkeysib-xxxxxxxxxxxxxxxxxxxxx"

Build your message

let message = new SendSmtpEmail();
message.subject = "First email";
message.textContent = "Hello world!";
message.sender = { name: "John Doe", email: "[email protected]" };
message.to = [{ email: "[email protected]", name: "Jane Smith" }];

Send the message

emailAPI.sendTransacEmail(message)

(Optional) Log the response

emailAPI.sendTransacEmail(message).then(res => {
    console.log(JSON.stringify(res.body));
}).catch(err => {
    console.error("Error sending email:", err.body);
});

Create Contact

Installation

npm i @getbrevo/brevo^3.0.1 --save

Import packages

import { CreateContact, ContactsApi } from "@getbrevo/brevo^3.0.1";

Instantiate API with your credentials

let contactAPI = new ContactsApi();
contactAPI.authentications.apiKey.apiKey = "xkeysib-xxxxxx"

Build your contact

let contact = new CreateContact();
contact.email = "[email protected]";
contact.attributes = {
  FIRSTNAME: "Alice",
  LASTNAME: "Johnson",
};

Create the contact

contactAPI.createContact(contact).then(res => {
  console.log(JSON.stringify(res.body));
}).catch(err => {
  console.error("Error creating contact:", err.body);
});

TypeScript Implementation

Recommended tsconfig.json Settings

We recommend using the following TypeScript configuration for optimal compatibility:

{
  "compilerOptions": {
    "target": "es2020",
    "module": "commonjs",
    "outDir": "dist",
    "rootDir": "src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": ["src"]
}

Send Transactional Email

Installation

npm i @getbrevo/brevo^3.0.1 --save

Import packages

import { TransactionalEmailsApi, SendSmtpEmail } from "@getbrevo/brevo^3.0.1";

Instantiate API with your credentials

let emailAPI = new TransactionalEmailsApi();
(emailAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxxxxxxxxxxxxxx";

Build your message

let message = new SendSmtpEmail();
message.subject = "First email";
message.textContent = "Hello world!";
message.sender = { name: "Bob Wilson", email: "[email protected]" };
message.to = [{ email: "[email protected]", name: "Sarah Davis" }];

Send the message

emailAPI.sendTransacEmail(message)

(Optional) Log the response

emailAPI
  .sendTransacEmail(message)
  .then((res) => {
    console.log(JSON.stringify(res.body));
  })
  .catch((err) => {
    console.error("Error sending email:", err.body);
  });

Create Contact

Installation

npm i @getbrevo/brevo^3.0.1 --save

Import packages

import { CreateContact, ContactsApi } from "@getbrevo/brevo^3.0.1";

Instantiate API with your credentials

let contactAPI = new ContactsApi();
(contactAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxx"

Build your contact

let contact = new CreateContact();
contact.email = "[email protected]";
contact.attributes = {
  FIRSTNAME: { value: "Michael" },
  LASTNAME: { value: "Brown" },
};

Create the contact

contactAPI.createContact(contact).then(res => {
  console.log(JSON.stringify(res.body));
}).catch(err => {
  console.error("Error creating contact:", err.body);
});

Concerning v3.0.0 and above:

[!IMPORTANT] There has been a change in the usage of this library after v3.0.0 which is not backward compatible.

Installation

npm i @getbrevo/brevo^3.0.1 --save

Import packages

import { CreateContact, ContactsApi } from "@getbrevo/brevo^3.0.1";

Instantiate API with your credentials

let contactAPI = new ContactsApi();
(contactAPI as any).authentications.apiKey.apiKey = "xkeysib-xxxxxxxxx";

Build your contact

contact.email = "[email protected]";
contact.attributes = {
  FIRSTNAME: { value: "Michael" },
  LASTNAME: { value: "Brown" }
};

Create the contact

  console.log(JSON.stringify(res.body));
}).catch(err => {
  console.error("Error creating contact:", err.body);
});

Similar other examples:

import { TransactionalEmailsApi, TransactionalEmailsApiApiKeys } from '@getbrevo/brevo^3.0.1';

const transactionalEmailsApi = new TransactionalEmailsApi();
transactionalEmailsApi.setApiKey(TransactionalEmailsApiApiKeys.apiKey, 'xkeysib-API_KEY');

async function sendTransactionalEmail() {
  try {
    const result = await transactionalEmailsApi.sendTransacEmail({
      to: [
        { email: '[email protected]', name: 'John doe' },
      ],
      subject: 'Hello from Brevo SDK!',
      htmlContent: '<h1>This is a transactional email sent using the Brevo SDK.</h1>',
      textContent: 'This is a transactional email sent using the Brevo SDK.',
      sender: { email: '[email protected]', name: 'John doe' },
    });
    console.log('Email sent! Message ID:', result.body.messageId);
  } catch (error) {
    console.error('Failed to send email:', error);
  }
}

sendTransactionalEmail(); 

import { DealsApi, DealsApiApiKeys } from '@getbrevo/brevo^3.0.1';

const dealsApi = new DealsApi();
dealsApi.setApiKey(DealsApiApiKeys.apiKey, 'xkeysib-YOUR_API_KEY');

async function getDeals() {
  try {
    const response = await dealsApi.crmDealsGet()
    console.log('Deals info:', response.body);
  } catch (error) {
    console.error('Failed to get account info:', error);
  }
}

getDeals();

import { AccountApi, AccountApiApiKeys } from '@getbrevo/brevo^3.0.1';

const accountApi = new AccountApi();
accountApi.setApiKey(AccountApiApiKeys.apiKey, 'xkeysib-YOUR_API_KEY');

async function getAccount() {
  try {
    const response = await accountApi.getAccount();
    console.log('Account info:', response.body);
  } catch (error) {
    console.error('Failed to get account info:', error);
  }
}

getAccount();

import { ContactsApi, ContactsApiApiKeys } from '@getbrevo/brevo^3.0.1';

const contactsApi = new ContactsApi();
contactsApi.setApiKey(ContactsApiApiKeys.apiKey, 'xkeysib-YOUR_API_KEY');

async function getContacts(limit: number, offset: number) {
  try {
    const result = await contactsApi.getContacts(limit, offset);
    console.log('Contacts:', result.body);
  } catch (error) {
    console.error('Failed to get contacts:', error);
  }
}

getContacts(10, 0); // Example: get first 10 contacts 

Support

For questions and support, please refer to our documentation or contact our support team.

License

This SDK is distributed under the MIT License.