Onvo Documentation
Concepts
Automations

Automations

An automation allows you to send dashboards to your users on a fixed schedule.

Automation fields

title
string
required

The title or name of the automation.

created_at
string

The timestamp indicating when the automation was created.

created_by
string

The identifier of the user who created the automation.

dashboard
string
required

The identifier of the dashboard associated with the automation.

description
string

A description of the automation.

email_format
string

The format or template for the email generated by the automation.

email_subject
string

The subject line of the email generated by the automation.

enabled
boolean
required

Indicates whether the automation is currently enabled.

id
string

The unique identifier for the automation.

last_run_at
string

The timestamp indicating when the automation was last run.

last_updated_at
string

The timestamp indicating when the automation was last updated.

last_updated_by
string

The identifier of the user who last updated the automation.

next_run_at
string

The timestamp indicating when the automation is scheduled to run next.

output_format
string
required

The format or type of output generated by the automation. can be of type excel, csv, link, pdf or image.

recipient_type
string
required

The type or category of recipients for the automation. Can be of type internal or external.

recipients
string[]
required

An array of emails representing the recipients of the automation.

schedule
string
required

The schedule or frequency at which the automation runs as a cron tab. Eg: 30 4 1,15 * 5

timezone
string
required

The timezone in which the automation is configured to run in lowercase. You can find the list of timezones here: https://timezonedb.com/time-zones (opens in a new tab)

team
string

The identifier of the team to which the automation belongs.