Skip to main content
POST
Add a trigger to an automation

Authorizations

Authorization
string
header
required

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, plugins:read, secrets:read, secrets:write, sessions:read, knowledge:read, repos:read, repos:write, reviews:read, reviews:write, analytics:read, org:read, org:write, attachments:read, attachments:write, plugins:write, guardrails:read, guardrails:write.

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

automationId
string
required

Body

application/json

Adds a schedule trigger to the automation. Provide exactly one of frequency, every_seconds, or scheduled_at.

frequency
string

Cron expression, e.g. 0 3 * * *, for a recurring trigger.

every_seconds
integer

Fixed interval in seconds. Alternative to frequency.

scheduled_at
string<date-time>

Run-at time for a one-time trigger. Alternative to frequency.

enabled
boolean
default:true

Response

Created.

A condition that fires the automation. The webhook secret is never returned.

id
string
kind
enum<string>
Available options:
schedule,
github_event,
webhook
enabled
boolean
schedule
object | null
github
object | null
webhook
object | null
run_kind
string | null
last_fired_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>