Skip to main content
POST
Create a trigger in a workspace

Authorizations

Authorization
string
header
required

Account API key: key id as the username, secret as the password.

Path Parameters

workspace_id_or_name
string
required

Body

application/json
workspace_agent_id
string<uuid>
required

The installed workspace agent the trigger runs.

type
enum<string>
required
Available options:
time
frequency
enum<string>
required
Available options:
HOURLY,
DAILY,
WEEKLY,
MONTHLY,
CRON
agent_input
object
required

The fixed input the agent receives each time the trigger fires.

time_of_day
string | null

Time of day in ISO format, such as 09:00. Used by DAILY, WEEKLY, and MONTHLY.

days_of_week
string | null

Comma-separated day names, such as monday,thursday. Used by WEEKLY.

days_of_month
string | null

Comma-separated days from 1 to 31, or -1 for the last day of the month. Used by MONTHLY.

minutes_of_hour
string | null

Comma-separated minutes from 0 to 59.

cron_expression
string | null

A five-field cron expression, such as 0 9 * * 1-5. Required for CRON and rejected for other frequencies.

cron_timezone
string | null

An IANA timezone name for cron_expression, such as America/Los_Angeles. Valid only for CRON.

Response

The created trigger

The response is of type object.