API Reference
Sending
Domains
Broadcasts
Contacts
Contact Properties
Segments
Audiences
DEPRECATEDTemplates
Automations
BETAimport { Resend } from 'resend';
const resend = new Resend('re_xxxxxxxxx');
const { data, error } = await resend.automations.create({
name: 'Welcome series',
status: 'disabled',
steps: [
{
ref: 'trigger',
type: 'trigger',
config: { eventName: 'user.created' },
},
],
edges: [],
});
{
"object": "automation",
"id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd"
}
Create Automation
Create a new automation to automate email sequences.
POST
/
automations
import { Resend } from 'resend';
const resend = new Resend('re_xxxxxxxxx');
const { data, error } = await resend.automations.create({
name: 'Welcome series',
status: 'disabled',
steps: [
{
ref: 'trigger',
type: 'trigger',
config: { eventName: 'user.created' },
},
],
edges: [],
});
{
"object": "automation",
"id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd"
}
Automations are currently in private alpha and only available to a limited
number of users. APIs might change before GA.To use the methods on this page, you must upgrade your Resend SDK:Contact us if you’re interested in testing
this feature.
npm install resend@6.10.0-preview-workflows.3
Body Parameters
The name of the automation.
The status of the automation. Possible values are
enabled or disabled.
Defaults to disabled.An array of step objects that define the automation’s actions. Must include at least one trigger step.
Show step properties
Show step properties
A unique reference identifier for the step. Used in edge definitions to connect steps.
The type of step. Possible values are
trigger, send_email, delay,
wait_for_event, condition, contact_update, contact_delete,
add_to_segment.The configuration object for the step. The shape depends on the step
type.Show trigger configuration
Show trigger configuration
Show send_email configuration
Show send_email configuration
Show delay configuration
Show delay configuration
The delay duration in seconds.
Show wait_for_event configuration
Show wait_for_event configuration
Show condition configuration
Show condition configuration
Condition configs can be a single rule or a logical group (For For
and/or) of rules.The type of condition node. Possible values are
rule, and, or.rule type:The field to evaluate. Must use the
event. namespace prefix (e.g.,
event.amount, event.plan).The comparison operator. Possible values are
eq, neq, gt, gte, lt,
lte, contains, starts_with, ends_with, exists, is_empty.The value to compare against. Not required for
exists and is_empty
operators.and / or types:An array of nested condition config objects. Must contain at least one item.
Show contact_update configuration
Show contact_update configuration
The
contact_update step updates a contact’s fields. Each field value can be either a hardcoded value or a dynamic variable reference using the { var: '...' } syntax.Variable references use dot-notation with one of these scopes:event.*— references a field from the triggering event payload (e.g.,event.firstName).contact.*— references a field from the current contact (e.g.,contact.last_name,contact.properties.company).
Show contact_delete configuration
Show contact_delete configuration
The
contact_delete step does not require any configuration fields. Pass an
empty object {} as the config.Show add_to_segment configuration
Show add_to_segment configuration
An array of edge objects that define connections between steps.
Can be an empty array for single-step automations.
Show edge properties
Show edge properties
In create/update requests, the
ref of the source step. In retrieve
responses, an internal identifier for the source step. Retrieved steps
include only type and config (no id or ref).In create/update requests, the
ref of the destination step. In
retrieve responses, an internal identifier for the destination step.
Retrieved steps include only type and config (no id or ref).import { Resend } from 'resend';
const resend = new Resend('re_xxxxxxxxx');
const { data, error } = await resend.automations.create({
name: 'Welcome series',
status: 'disabled',
steps: [
{
ref: 'trigger',
type: 'trigger',
config: { eventName: 'user.created' },
},
],
edges: [],
});
{
"object": "automation",
"id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd"
}
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.