Skip to main content
POST
/
v1
/
schedules
Create schedule
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "name": "<string>",
  "schedule": "<string>",
  "timezone": "<string>",
  "format": "json",
  "destinationType": "webhook",
  "filterConfig": {},
  "conditionType": "RESULTS_PRESENT",
  "conditionQueryMapKey": "<string>",
  "queryIdentifierMapKey": "<string>",
  "overrideRowLimit": 123,
  "maxRowLimit": 123,
  "testNow": true,
  "hideTitle": true,
  "url": "<string>",
  "recipients": [
    "<string>"
  ],
  "subject": "<string>",
  "textBody": "<string>",
  "fanOut": true,
  "paperFormat": "<string>",
  "paperOrientation": "portrait",
  "expandTablesToShowAllRows": true,
  "address": "<string>",
  "port": 123,
  "username": "<string>",
  "passwordUnencrypted": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "Successfully created schedule"
}

Authorizations

​
Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
​
identifier
string
required

Dashboard ID

​
name
string
required

Schedule name

​
schedule
string
required

Cron expression

​
timezone
string
required

IANA timezone (e.g., "America/New_York")

​
format
enum<string>
required

Export format

Available options:
json,
pdf,
xlsx,
png
​
destinationType
enum<string>
required

Delivery destination type

Available options:
webhook,
email,
sftp
​
filterConfig
object

Filter configuration

​
conditionType
enum<string>

Condition for execution

Available options:
RESULTS_PRESENT,
RESULTS_CHANGED
​
conditionQueryMapKey
string

Query key for condition

​
queryIdentifierMapKey
string

Single tile delivery query key

​
overrideRowLimit
integer

Override row limit

​
maxRowLimit
integer

Maximum row limit

​
testNow
boolean

Test schedule immediately

​
hideTitle
boolean

Hide title (PDF/PNG only)

​
url
string

Webhook URL

​
recipients
string[]

Email recipients

​
subject
string

Email subject

​
textBody
string

Email body text

​
fanOut
boolean

Fan out delivery

​
paperFormat
string

Paper format for PDF

​
paperOrientation
enum<string>

Paper orientation for PDF

Available options:
portrait,
landscape
​
expandTablesToShowAllRows
boolean

Expand tables in export

​
address
string

SFTP server address

​
port
integer

SFTP port

​
username
string

SFTP username

​
passwordUnencrypted
string

SFTP password

Response

Schedule created successfully

​
id
string<uuid>
​
message
string
Example:

"Successfully created schedule"