Node.js library for Braze (see demo). The types are inspired by Braze's Postman collection.
import { Braze } from 'braze-api'
const braze = new Braze('YOUR_API_URL', 'YOUR_API_KEY')
await braze.messages.send({
external_user_ids: ['your_external_user_id'],
messages: {
email: {
app_id: 'your_app_id',
from: 'Company <company@example.com>',
email_template_id: 'your_email_template_id',
},
},
})
See Braze API guide and Braze's Postman collection.
NPM:
npm install braze-api
Yarn:
yarn add braze-api
The package needs to be configured with your account's REST endpoint and API key:
const { Braze } = require('braze-api')
const braze = new Braze('YOUR_API_URL', 'YOUR_API_KEY')
The same can be done with ES Modules:
import { Braze } from 'braze-api'
const braze = new Braze('YOUR_API_URL', 'YOUR_API_KEY')
Use the REST endpoint provisioned to your account when you log in to the dashboard:
| Instance | REST Endpoint |
|---|---|
| US-01 | https://rest.iad-01.braze.com |
| US-02 | https://rest.iad-02.braze.com |
| US-03 | https://rest.iad-03.braze.com |
| US-04 | https://rest.iad-04.braze.com |
| US-05 | https://rest.iad-05.braze.com |
| US-06 | https://rest.iad-06.braze.com |
| US-08 | https://rest.iad-08.braze.com |
| EU-01 | https://rest.fra-01.braze.eu |
| EU-02 | https://rest.fra-02.braze.eu |
The API key can be created in your Braze dashboard.
This library currently supports a subset of the Braze API endpoints. Pull requests are welcome.
Release is automated with Release Please.
FAQs
Track users, send messages, export data, and more with Braze API.
The npm package braze-api receives a total of 8,665 weekly downloads. As such, braze-api popularity was classified as popular.
We found that braze-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.