sendlayer

SendLayer Node.js SDK

The official JavaScript SDK for interacting with the SendLayer API, providing a simple and intuitive interface for sending emails, managing webhooks, and retrieving email events. Supports both CommonJS and ES Modules.

Installation

npm install sendlayer

Usage

Sending an Email

import { SendLayer } from 'sendlayer';

// Initialize the client
const sendlayer = new SendLayer('your-api-key');


const params = {
  from: '[e-mail]',
  to: '[e-mail]', // or array of recipients
  subject: 'Test Email',
  text: 'This is a test email'
}

// Send a simple email
const response = await sendlayer.Emails.send(params);

console.log('Email sent! Message ID:', response.MessageID);

Sending Emails with additional parameters

import { SendLayer } from 'sendlayer';

// Initialize the client
const sendlayer = new SendLayer('your-sendlayer-api-key');

const params = {
  from: {email: '[e-mail]', name: 'Test Sender'},
  to: [
    { email: '[e-mail]', name: 'Recipient 1' },
    { email: '[e-mail]', name: 'Recipient 2' }
  ], 
  subject: 'Test Email',
  html: '<p>This is a test email</p>', // or text for plain text emails
  text: 'This is a test email', // optional, for plain text version
  cc: [{ email: '[e-mail]', name: 'CC Recipient' }], // optional
  bcc: [{ email: '[e-mail]', name: 'BCC Recipient' }], // optional
  replyTo: [{ email: '[e-mail]', name: 'Reply To' }], // optional
  tags: ['tag1', 'tag2'], // optional
  headers: { 'X-Custom-Header': 'value' }, // optional
  attachments: [{ // optional
    path: 'path/to/file.pdf',
    type: 'application/pdf',
  }]
}

// Send an email with additional parameters
const response = await sendlayer.Emails.send(params);

console.log('Email Sent successfully! MessageID:', response.MessageID)

Events

import { SendLayer } from 'sendlayer';

// Initialize the client
const sendlayer = new SendLayer('your-api-key');


// Get all events
const allEvents = await sendlayer.Events.get();

console.log('All Events:', allEvents);

// Get events with optional filters
const params = {
  startDate: new Date(Date.now() - 24 * 60 * 60 * 1000), // optional, last 24 hours
  endDate: new Date(), // optional
  event: 'opened', // optional, filter by event type
}
const filteredEvents = await sendlayer.Events.get(params);

console.log('Filtered Events', filteredEvents)

Webhooks

import { SendLayer } from 'sendlayer';

// Initialize the client
const sendlayer = new SendLayer('your-api-key');

// Create a webhook
// Webhook event options: bounce, click, open, unsubscribe, complaint, delivery
const params = {
  url: 'https://your-domain.com/webhook',
  event: 'open'
}

const webhook = await sendlayer.Webhooks.create(params);
console.log('Webhook created:', webhook);

// Get all webhooks
const allWebhooks = await sendlayer.Webhooks.get();
console.log('Webhooks:', allWebhooks);

// Delete a webhook
await sendlayer.Webhooks.delete(123);

Error Handling

The SDK throws the following error types:

• SendLayerAPIError: API request failed
• SendLayerError: Validation errors

try {
  await sendlayer.Emails.send({
    from: '[e-mail]',
    to: '[e-mail]',
    subject: 'Test Email',
    text: 'This is a test plain text email message'
  });

} catch (error) {
  if (error.name === 'SendLayerAPIError') {
    console.error('API error:', error.message);
  } else {
    console.error('Error:', error.message);
  }
}

More Details

To learn more about using the SendLayer SDK, be sure to check our Developer Documentation.

License

MIT License - see LICENSE file for details