Setting the file. One moment.
Subchapter 4.3
references/automations.mdMarkdown5 KBView on GitHub
Detailed flag specifications for resend automations and resend events commands.
| Flag | Type | Default | Description |
|---|---|---|---|
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
| Flag | Type | Required | Description |
|---|---|---|---|
--name <name> | string | Yes (unless in --file) | Automation name |
--status <status> | string | No | Initial status: enabled or disabled |
--steps <json> | string | Yes (unless --file) | Steps array as JSON string |
--connections <json> | string | Yes (unless --file) | Connections array as JSON string |
--file <path> | string | No | Path to JSON file with full payload (use "-" for stdin) |
When using --file, the JSON object should contain { name, status?, steps, connections }. Flags override file values.
Step types: trigger, delay, send_email, wait_for_event, condition
Connection types: default, condition_met, condition_not_met, timeout, event_received
resend automations get <id>Returns the full automation object including steps and connections.
| Flag | Type | Required | Description |
|---|---|---|---|
--status <status> | string | Yes | enabled or disabled |
resend automations update <id> --status enabledresend automations duplicate <id>Creates a copy of an existing automation, including its steps and connections.
Returns {"object":"automation","id":"<new-automation-id>"}.
resend automations stop <id>Stops a running automation by setting its status to disabled and cancelling active runs.
Returns {"object":"automation","id":"<id>","status":"disabled"}.
| Flag | Type | Required | Description |
|---|---|---|---|
--yes | boolean | Yes (non-interactive) | Skip confirmation |
resend automations open [id]Opens the automations list or a specific automation’s editor in the dashboard.
| Flag | Type | Default | Description |
|---|---|---|---|
--status <status> | string | — | Filter by status (comma-separated: running, completed, failed, cancelled) |
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
resend automations runs <automation-id>
resend automations runs list <automation-id> --status running
resend automations runs list <automation-id> --status completed,failedRun status values: running | completed | failed | cancelled
| Flag | Type | Required | Description |
|---|---|---|---|
--automation-id <id> | string | Yes | Automation ID |
--run-id <id> | string | Yes | Run ID |
Returns the full run object including step-level execution details.
| Flag | Type | Default | Description |
|---|---|---|---|
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
| Flag | Type | Required | Description |
|---|---|---|---|
--name <name> | string | Yes | Event name (e.g. user.signed_up) |
--schema <json> | string | No | JSON object mapping field names to types (string, number, boolean, date) |
Event names cannot start with resend: (reserved).
resend events get <id>Accepts an event ID.
| Flag | Type | Required | Description |
|---|---|---|---|
--schema <json> | string | Yes | Updated schema JSON (pass null to clear) |
| Flag | Type | Required | Description |
|---|---|---|---|
--yes | boolean | Yes (non-interactive) | Skip confirmation |
| Flag | Type | Required | Description |
|---|---|---|---|
--event <name> | string | Yes | Event name to trigger |
--contact-id <id> | string | One of --contact-id or --email | Contact ID |
--email <address> | string | One of --contact-id or --email | Contact email |
--payload <json> | string | No | JSON payload matching the event schema |
resend events openOpens the events management page in the dashboard.