Skip to main content
POST
https://api.resend.com
/
workflows
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.workflows.create({
  name: 'Welcome series',
  status: 'disabled',
  steps: [
    {
      ref: 'trigger',
      type: 'trigger',
      config: { eventName: 'user.created' },
    },
  ],
  edges: [],
});

{
  "object": "workflow",
  "id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd"
}
Workflows 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:
npm install resend@6.10.0-canary.0
Contact us if you’re interested in testing this feature.

​
Body Parameters

​
name
string
required
The name of the workflow.
​
status
string
The status of the workflow. Possible values are enabled or disabled. Defaults to disabled.
​
steps
object[]
required
An array of step objects that define the workflow’s actions. Must include at least one trigger step.
​
edges
object[]
required
An array of edge objects that define connections between steps.
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.workflows.create({
  name: 'Welcome series',
  status: 'disabled',
  steps: [
    {
      ref: 'trigger',
      type: 'trigger',
      config: { eventName: 'user.created' },
    },
  ],
  edges: [],
});

{
  "object": "workflow",
  "id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd"
}