Routines

Create a routine

Schedule regeneration of a report on a 5-field cron. Provide trigger_url (webhook mode — Comma calls your endpoint on each tick) and/or skill_id (in-Comma run mode — the skill executes and appends a revision); at least one is required. Requires edit access on report_id. Plan ceilings (max routines / schedule floor) return 422. Scope: routines.

post/routines

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/routines
  • Auth: HTTP bearer

Request body

report_idstring uuid required
namestring

Defaults to 'Untitled routine'.

schedule_cronstring required

Valid 5-field cron expression.

trigger_urlstring uri

Webhook mode: Comma POSTs here on each tick.

trigger_auth_headerstring nullable

Encrypted at rest; never returned.

payloadunknown
enabledboolean
skill_idstring uuid nullable

In-Comma run mode: the skill executes and appends a revision. Must be owned by you.

connector_idsstring[]

Connectors the skill may read through. Each must be owned by you.

Response

Routine created.

idstring uuid required
report_idstring uuid required
namestring required
schedule_cronstring required

5-field cron expression.

trigger_urlstring uri nullable
payloadunknown
enabledboolean required
last_run_atstring date-time nullable
last_run_statusstring nullable
last_run_errorstring nullable
next_run_atstring date-time nullable
skill_idstring uuid nullable
connector_idsstring[]
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.