Skip to main content
POST
Create a cron trigger

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required

Body

application/json
name
string
required

Trimmed before validation.

Required string length: 1 - 80
schedule
string
required

5-field cron expression (minute hour day-of-month month day-of-week), UTC. Parsed at create time; a bad expression is rejected.

payload

JSON template fired on each run. A string is stored verbatim; any other value is JSON.stringify'd; omitted becomes '{}'. Must still parse as JSON after {{now}}/{{iso}}/{{ts}} substitution.

dataset
string | null

Optional identity dataset. When absent the fired payload is routed through the project's mapping rules instead.

Response

Created and enabled. NOTE: this handler returns 200, not 201.

id
string
required
next_run_at
string<date-time>
required