BAbasedash
Automations

Create an automation

Creates an automation for an organization. Requires admin access to the organization.

post/api/public/organizations/{orgId}/automations

Request

  • Base URL
    https://charts.basedash.com
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Organization ID

Request body

namestring required

Automation name

iconstring

Icon name

colorstring

Icon color

instructionsstring required

Automation instructions

activeboolean
triggerType'MANUAL' | 'SCHEDULE' | 'DATA_CHANGE'

Automation trigger type

frequency'DAILY' | 'WEEKDAYS' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY'

Schedule frequency

preferredHourinteger

Preferred UTC hour

preferredDayOfWeekinteger nullable
preferredDayOfMonthinteger nullable
triggerDatabaseConnectionIdstring nullable
triggerSqlQuerystring
slackChannelstring nullable
emailRecipientsstring

Response

Automation created successfully

Changes

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