Skip to main content
POST
Create an automation

Authorizations

Authorization
string
header
required

A Parley API key.

Body

application/json
name
string
required

The automation name.

Required string length: 1 - 120
instructions
string
required

The prompt Parley's assistant carries out on every run, up to 20,000 characters. Nobody is there to answer questions during a run, so say what to check, what counts as worth reporting, and what the report should look like.

Required string length: 1 - 20000
description
string

A short summary of what the automation does.

Maximum string length: 2000
triggers
object[]

What starts the automation on its own, such as [{ "type": "cron", "cron": "0 9 * * 1-5" }] for 9:00 AM on weekdays. At most 10. Leave it out for an automation that only runs when someone starts a run.

Maximum array length: 10

A trigger to add, such as { "type": "cron", "cron": "0 9 * * 1-5" } for 9:00 AM on weekdays, or { "type": "event", "event": "project.created" } for each new project.

projectId
string

A project to run the automation in, which needs edit access to it. Leave it out for an automation that runs across the organization.

Minimum string length: 1

Response

Created.

id
string
required

The automation ID.

Minimum string length: 1
name
string
required

The automation name.

description
string | null
required

A short summary of what the automation does, or null.

status
enum<string>
required

active: the automation runs when its triggers fire. paused: its triggers are on hold, and the automation only runs when someone starts a run.

Available options:
active,
paused
nextRunAt
string<date-time> | null
required

When a trigger next starts a run, or null for an automation that is paused or has no scheduled trigger.

project
object | null
required

The project the automation runs in, with that project's files, notes, and linked records as its context, or null for an automation that runs across the organization.

lastRun
object | null
required

The most recent run, or null for an automation that has never run.

createdAt
string<date-time>
required

When the automation was created.

updatedAt
string<date-time>
required

When the automation or its triggers were last changed.

triggers
object[]
required

What starts the automation on its own, oldest first. Empty for an automation that only runs when someone starts a run.

Something that starts a run. cron: a schedule. event: something that happens in Parley. More types will be added, so skip any type you do not recognize.

instructions
string
required

The automation's instructions: the prompt Parley's assistant carries out on every run.