Skip to main content
POST
Create an automation

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

Body

application/json
name
string
required

Automation name

Minimum string length: 1
instructions
string
required

Automation instructions

icon
string
default:stopwatch

Icon name

color
string
default:1

Icon color

active
boolean
default:true
triggerType
enum<string>
default:SCHEDULE

Automation trigger type

Available options:
MANUAL,
SCHEDULE,
DATA_CHANGE
frequency
enum<string>
default:DAILY

Schedule frequency

Available options:
DAILY,
WEEKDAYS,
WEEKLY,
MONTHLY,
QUARTERLY
preferredHour
integer
default:9

Preferred UTC hour

Required range: 0 <= x <= 23
preferredDayOfWeek
integer | null
Required range: 0 <= x <= 6
preferredDayOfMonth
integer | null
Required range: 1 <= x <= 31
triggerDatabaseConnectionId
string | null
triggerSqlQuery
string
default:""
slackChannel
string | null
emailRecipients
string
default:""

Response

Automation created successfully

data
object
required