PAparley
Automations

Run an automation now

Start a run of an automation now, without waiting for a trigger. A paused automation can be run too. Returns the run as soon as it's queued; follow its progress by listing the automation's runs. Returns 429 USAGE_LIMIT_REACHED when the organization has reached its limit of automation runs for a given period; don't retry until older runs fall outside that window.

post/automations/{id}/runs

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/automations/{id}/runs
  • Auth
    HTTP bearer

Path parameters

idstring required

The automation ID.

Response

Created.

idstring required

The run ID.

status'pending' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'timed_out' required

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

triggerType'cron' | 'manual' | 'event' | 'slack' required

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

triggerIdstring nullable required

The trigger ID.

scheduledForstring date-time nullable required

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

startedAtstring date-time nullable required

When the run started.

endedAtstring date-time nullable required

When the run finished.

sessionIdstring nullable required

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

createdAtstring date-time required

When the run was queued.

Changes

No recorded changes to this operation across all 2 revisions of this API.