Kadoa Dashboard
Support
Kadoa Dashboard

Workflows

Create a new workflow

Documentation

Introduction
Quickstart
Workflow States
Schemas and Templates
Credits
Crawling 101
Workspaces
Chrome Extension
Monitoring
Integrations
Advanced Workflows
Security

API Reference

Introduction
Crawling
Workflows
Monitoring
Advanced Workflows
Templates
Adhoc
Events
Webhooks

Workflows

Create a new workflow

POST

workflows

x-api-key

string

x-api-key

Required

string

object

templateId

string

templateId

Required

string

Template ID

link

string

link

Required

string

Link

name

string

name

Required

string

Name of the workflow

updateInterval

enum<string>

updateInterval

enum<string>

Update interval (e.g., ONLY_ONCE, HOURLY, DAILY, etc.)

schedules

array

schedules

array

Array of cron expressions specifying when to run the workflow

monitoring

object

monitoring

object

Configuration for monitoring

enabled

boolean

enabled

boolean

Whether monitoring is enabled

fields

array

fields

array

Array of fields to monitor (only needed if mode is CHANGED)

mode

enum<string>

mode

enum<string>

Monitoring mode

channels

array

channels

array

Array of channels for notifications (only one channel allowed)

limit

integer

limit

integer

Limit for the workflow execution

location

object

location

object

The location for the workflow

type

enum<string>

type

enum<string>

The type of location for the workflow

Add Example Value

isoCode

string

isoCode

string

The ISO code for the location that can be fetched from the location object

Add Example Value

Authorizations

x-api-key

string

headerrequired

Body

application/json

templateId

string

required

Template ID

link

string

required

Link

name

string

required

Name of the workflow

updateInterval

enum<string>

Update interval (e.g., ONLY_ONCE, HOURLY, DAILY, etc.)

Available options:

ONLY_ONCE,

HOURLY,

DAILY,

WEEKLY,

MONTHLY

schedules

string[]

Array of cron expressions specifying when to run the workflow

monitoring

object

Configuration for monitoring

monitoring.enabled

boolean

Whether monitoring is enabled

monitoring.fields

string[]

Array of fields to monitor (only needed if mode is CHANGED)

monitoring.mode

enum<string>

Monitoring mode

Available options:

ADDED,

CHANGED

monitoring.channels

object[]

Array of channels for notifications (only one channel allowed)

monitoring.channels.type

enum<string>

Type of channel

Available options:

EMAIL,

SLACK

monitoring.channels.emails

string[]

Array of email addresses for notifications (for EMAIL type)

monitoring.channels.url

string

Slack webhook URL (for SLACK type)

limit

integer

Limit for the workflow execution

location

object

The location for the workflow

location.type

enum<string>

The type of location for the workflow

Available options:

auto,

manual

location.isoCode

string

The ISO code for the location that can be fetched from the location object

Response

201 - application/json

success

boolean

workflowId

string

info

string

Get workflow by ID Run a workflow