Create a scheduled task

Creates a recurring query task with a cron schedule and delivery channel. Requires admin role.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 200

question*string

Length1 <= length <= 2000

cronExpression*string

Length1 <= length

deliveryChannel?string

Default"webhook"

Value in"email" | "slack" | "webhook"

recipients?array<||>

Default[]

connectionId?|

approvalMode?string

Default"auto"

Value in"auto" | "manual" | "admin-only"

Response Body

`application/json`

curl -X POST "http://localhost:3001/api/v1/scheduled-tasks" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "question": "string",    "cronExpression": "string"  }'

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string",
  "details": [
    null
  ]
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

Create a scheduled task

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`