Email Channel Step

Learn how to use the email step to send email notifications

The email step allows you to send email notifications to your users. This step supports HTML content and can be used with React Email for building beautiful email templates.

Example Usage

await step.email('welcome-email', async () => {
  return {
    subject: 'Welcome to Our Platform',
    body: "Hello and welcome! We're excited to have you on board.",
  };
});

Email Step Output

PropertyTypeRequiredDescription
subjectstringYesThe subject line of the email
bodystringYesThe content of the email. Can be plain text or HTML
attachmentsAttachment[]NoArray of files to attach to the email
fromstringNoOverride the default from address
replyTostringNoSet a reply-to address for the email

Email Step Result

The email step does not return any result object.

On this page