Skip to main content
POST
Schedule recurring exports of a saved definition

Path Parameters

definitionId
string
required

Report definition id (ULID)

Body

application/json
cron
string
required

5-field cron expression

delivery
object
required
timezone
string
default:Europe/London
format
enum<string>
default:CSV
Available options:
CSV,
JSONL

Response

Created

scheduleId
string
required
definitionId
string
required
cron
string
required
timezone
string
required
format
string
required
delivery
object
required
enabled
boolean
required
nextDueAt
string<date-time>
required
lastRunId
string | null

The run this schedule last started; null until it has fired once

lastDeliveryAt
string<date-time> | null

When the last report was last sent to the recipients

lastDeliveryStatus
enum<string> | null

DELIVERED or FAILED; null until the schedule has fired once

Available options:
DELIVERED,
FAILED
lastDeliveryError
string | null

Why the last report did not reach its recipients

consecutiveDeliveryFailures
integer<int32>
default:0

Failures in a row; back to 0 on the first success

webhookSecret
string | null
deprecated

Deprecated with webhookUrl: returned exactly once, on creation, to verify the legacy X-Flow-Signature header. Endpoints created through the Webhooks API carry their own signing secrets