POST
/
v4
/
workflows
curl --request POST \
  --url https://api.kadoa.com/v4/workflows \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "templateId": "<string>",
  "link": "<string>",
  "name": "<string>",
  "updateInterval": "ONLY_ONCE",
  "schedules": [
    "<string>"
  ],
  "monitoring": {
    "enabled": true,
    "fields": [
      "<string>"
    ],
    "mode": "ADDED",
    "channels": [
      {
        "type": "EMAIL",
        "emails": [
          "jsmith@example.com"
        ],
        "url": "<string>"
      }
    ]
  },
  "limit": 123,
  "location": {
    "type": "auto",
    "isoCode": "DE"
  },
  "tags": [
    "<string>"
  ]
}'
{
  "success": true,
  "workflowId": "<string>",
  "info": "<string>"
}

Authorizations

​
x-api-key
string
header
required

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

Cron expression

​
monitoring
object

Configuration for monitoring

​
limit
integer

Limit for the workflow execution

​
location
object

The location for the workflow

​
tags
string[]

The tags for the workflow

Response

201
application/json
Workflow created
​
success
boolean
​
workflowId
string
​
info
string
Get workflow by IDRun a workflow