Add a trigger to an automation

View as Markdown

Provide exactly one schedule: a frequency cron expression for recurring runs, every_seconds for a fixed interval, or a scheduled_at timestamp for a one-time run.

Scope: automations:write

Authentication

AuthorizationBearer

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

orgIdstringRequired

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

automationIdstringRequired

Request

This endpoint expects an object.
frequencystringOptional

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

every_secondsintegerOptional

Fixed interval in seconds. Alternative to frequency.

scheduled_atdatetimeOptional

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

enabledbooleanOptionalDefaults to true

Response

Created.
idstringOptional
kindenumOptional
enabledbooleanOptional
scheduleobject or nullOptional
githubobject or nullOptional
webhookobject or nullOptional
run_kindstring or nullOptional
last_fired_atdatetime or nullOptional
created_atdatetimeOptional
updated_atdatetimeOptional

Errors

400
Bad Request Error
404
Not Found Error