Create Schedule Trigger

Create a schedule trigger.

cron_expression is evaluated in timezone, which defaults to UTC. target_type is task or task_agent and target_id is that resource’s id. Set expires_at to stop firing after a date.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

OR
AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"
The organization ID
project_idstringRequiredformat: "uuid"
The project ID

Request

This endpoint expects an object.
namestringRequired1-63 characters
cron_expressionstringRequired<=255 characters
target_typeenumRequired
Target resource type for trigger execution.
target_idstringRequiredformat: "uuid"
descriptionstring or nullOptional<=255 characters
statusenumOptional
Lifecycle status for triggers.
timezonestringOptional<=63 charactersDefaults to UTC
task_inputmap from strings to any or nullOptional
expires_atdatetime or nullOptional
task_agent_revision_idstring or nullOptionalformat: "uuid"

Response

Schedule trigger created successfully
idstringformat: "uuid"
target_typeenum
Target resource type for trigger execution.
target_idstringformat: "uuid"
namestring
statusenum
Lifecycle status for triggers.
cron_expressionstring
timezonestring
createdstring
modifiedstring
created_by_user_idstringformat: "uuid"
task_agent_revision_idstring or nullformat: "uuid"
trigger_type"schedule"Defaults to schedule
descriptionstring or null
task_inputmap from strings to any or null
next_run_atstring or null
last_run_atstring or null
expires_atstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error