PAparley
Automations

Create an automation

Create an automation: instructions Parley's assistant carries out whenever one of its triggers fires, as you, with nobody present. The automation is active as soon as it's created. Without a trigger it only runs when someone starts a run with POST /automations/{id}/runs.

post/automations

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/automations
  • Auth
    HTTP bearer

Request body

namestring required

The automation name.

descriptionstring

A short summary of what the automation does.

instructionsstring 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.

projectIdstring

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

Response

Created.

idstring required

The automation ID.

namestring required

The automation name.

descriptionstring nullable required

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

status'active' | 'paused' 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.

nextRunAtstring date-time nullable required

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

createdAtstring date-time required

When the automation was created.

updatedAtstring date-time required

When the automation or its triggers were last changed.

instructionsstring required

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

Changes

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