payload usesend

PayloadCMS + useSend Email Adapter

useSend is an API-first email delivery platform built for transactional and marketing email workflows. It adopts an architectural model comparable to Resend while remaining fully open source and self-hostable. This combination enables teams to standardise email delivery without surrendering control over infrastructure, deployment topology, or data locality.

The platform exposes a REST-based interface for email delivery and supports provider-native capabilities such as templates, dynamic variables, and scheduled sends. By abstracting the underlying delivery infrastructure, useSend simplifies application integration while allowing organisations to retain operational and regulatory control.

This adapter integrates PayloadCMS with the useSend REST API for transactional and marketing emails.

Documentation

See the full documentation for comprehensive guides, features, comparisons, and configuration examples.

Installation

pnpm add @rubixstudios/payload-usesend

Usage

• Sign up for a useSend account
• Set up a domain
• Create an API key
• Set API key as USESEND_API_KEY environment variable
• Set your useSend base url as USESEND_URL environment variable
• Configure your Payload config

Configuration

// payload.config.js
import { sendAdapter } from '@rubixstudios/payload-usesend'

export default buildConfig({
  email: sendAdapter({
    apiKey: process.env.USESEND_API_KEY!,
    defaultFromAddress: '[email protected]',
    defaultFromName: 'Rubix Studios',
    useSendUrl: process.env.USESEND_URL!,

    // Optional
    // idempotencyKey: () => crypto.randomUUID(),
    // scheduledAt: '2025-08-01T10:00:00Z',
    // templateId: 'template-uuid',
    // variables: { firstName: 'Vincent' },
  }),
})

Custom email headers are set on the email message itself and are forwarded to useSend as the headers object:

await payload.sendEmail({
  to: '[email protected]',
  from: 'Rubix Studios <[email protected]>',
  subject: 'Welcome',
  html: '<p>Hello</p>',
  headers: {
    'List-Unsubscribe': '<https://example.com/unsubscribe>',
    'List-Unsubscribe-Post': 'List-Unsubscribe=One-Click',
  },
})

Option	Type	Required	Default	Description
apiKey	string	Yes	-	useSend API key
useSendUrl	string	Yes	-	useSend base URL
defaultFromAddress	string	Yes	-	Default sender email
defaultFromName	string	Yes	-	Default sender name
idempotencyKey	string | function	No	Auto	Unique key reused across retries
scheduledAt	string	No	-	ISO 8601 scheduled delivery date
templateId	string	No	-	Email template ID
variables	object	No	-	Email template variables

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support or inquiries:

• LinkedIn: rubixvi
• Website: Rubix Studios

Author

Rubix Studios
https://rubixstudios.com.au