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

Authorizations

X-Auth-Token
string
header
required

FlowPayroll JWT (raw token, no Bearer prefix)

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

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 — webhookSecret is returned exactly once, here

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
webhookSecret
string | null

Returned exactly once, on creation — used to verify X-Flow-Signature