Skip to main content
POST
Run an automation now

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The automation ID.

Minimum string length: 1

Response

Created.

id
string
required

The run ID.

Minimum string length: 1
automation
object
required

The automation that ran.

status
enum<string>
required

pending: queued and not yet started. running: in progress. succeeded, failed, canceled, and timed_out are final.

Available options:
pending,
running,
succeeded,
failed,
canceled,
timed_out
triggerType
enum<string>
required

What started the run: a trigger of this type, or manual for a run someone started themselves.

Available options:
cron,
manual,
event
event
object | null
required

The event that started the run and the record it happened to, or null for a run that no event started.

triggerId
string | null
required

The trigger that started the run, or null for a manual run or a trigger that has since been removed.

Minimum string length: 1
scheduledFor
string<date-time> | null
required

The time a cron trigger set for the run, or null for a run that no cron trigger started.

startedAt
string<date-time> | null
required

When the run started.

endedAt
string<date-time> | null
required

When the run finished.

error
object | null
required

Why the run didn't succeed, or null.

sessionId
string | null
required

The session the run worked in, whose messages hold its report, or null once that session is deleted.

createdAt
string<date-time>
required

When the run was queued.