Skip to content
SendByte Docs

Node.js

Install

Terminal window
npm install @sendbyte/node

Node 18+ (uses global fetch). Full TypeScript types included.

Use

import { SendByte, SendByteError } from '@sendbyte/node';


const sendbyte = new SendByte(process.env.SENDBYTE_API_KEY);


try {
  const { id } = await sendbyte.emails.send({
    from: 'PayLink <receipts@paylink.ng>',
    to: 'amaka@halo.ng',
    subject: 'Receipt for ₦45,000',
    html: '<p>Payment received. Thank you, Amaka.</p>',
    idempotency_key: 'order-4421-receipt',
  });
} catch (err) {
  if (err instanceof SendByteError) {
    console.error(err.code, err.message, err.docsUrl);
  }
}

Surface

  • emails.send(request) · emails.get(id) · emails.list({limit, after, status})
  • domains.create(domain) · domains.list() · domains.get(id) · domains.verify(id)
  • webhooks.create({url, events}) · webhooks.list() · webhooks.disable(id) · webhooks.replay(deliveryId)
  • verifyWebhookSignature(secret, header, rawBody) for inbound webhooks