This package provides a convenient interface to query the MagicBell API. Note that some methods depend on your secret key, those methods are not to be used in browsers, as your secret key must be kept secret.
Node 18.13 or higher.
When using older versions, you might need to polyfill fetch
. See isomorphic-fetch for more information.
You also might need to polyfill eventsource
when using the listen
method in an environment that doesn't support it. See eventsource for more information.
Install the package with npm:
npm install magicbell --save
or yarn:
yarn add magicbell
The package needs to be configured with your project's secret key & api key, which are available in the [MagicBell Dashboard][dashboard].
import { ProjectClient } from 'magicbell/project-client';
const magicbell = new ProjectClient({
apiKey: 'your-api-key',
apiSecret: 'your-api-secret',
});
try {
const broadcast = await magicbell.broadcasts.create({
title: 'Sweet!',
content: 'When you see it, you know it!',
recipients: [{ email: 'customer@example.com' }],
});
console.log(broadcast.id);
} catch (error) {
console.error(error);
}
Please see the MagicBell documentation for more information about this SDK.