POST operation for /workflows

Authorization

ApiKeyAuth

Authorization<token>

API key authentication. Format: Your API key (no "Token" prefix needed)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

workflow_type*string

Value in"quick_action" | "event" | "scheduled"

workflow_actions?string

trigger?string

Only required when workflow_type=event

Value in

"map-created" | "map-updated" | "map-status-updated" | "map-owner-updated" | "map-task-created" | "map-task-assignee-updated" | "map-task-due-date-updated" | "map-task-status-updated" | "map-section-completed" | "discussion-message-created" | "customer-created" | "customer-updated" | "custom-form-submitted"

internal_description?string

button_color?string

button_placement?string

Value in"map" | "map_task"

button_title?string

is_enabled?boolean

filters?object

filters_rql?string

is_hidden?boolean

schedule_type?string

Value in"daily" | "weekly" | "monthly"

schedule_day?integer

Day of the week as an integer (0 for Monday, 6 for Sunday)

schedule_time?string

Formattime

Response Body

`application/json`

curl -X POST "https://dev-rest.onboard.io/workflows" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "workflow_type": "quick_action",    "workflow_actions": "string",    "trigger": "map-created",    "internal_description": "string",    "button_color": "string",    "button_placement": "map",    "button_title": "string",    "is_enabled": true,    "filters": {},    "filters_rql": "string",    "is_hidden": true,    "schedule_type": "daily",    "schedule_day": 1,    "schedule_time": "string"  }'

{
  "id": 1,
  "name": "string",
  "workflow_type": "quick_action",
  "workflow_actions": "string",
  "workflow_actions_display": "string",
  "trigger": "map-created",
  "trigger_display": "string",
  "internal_description": "string",
  "created_at": "2021-01-01T00:00:00Z",
  "modified_at": "2021-01-01T00:00:00Z",
  "created_by": "string",
  "button_color": "string",
  "button_placement": "map",
  "button_title": "string",
  "is_enabled": true,
  "filters": {},
  "filters_rql": "string",
  "workflow_events": "string",
  "is_hidden": true,
  "schedule_type": "daily",
  "schedule_day": 1,
  "schedule_time": "string"
}

Empty

POST /workflows

Authorization

Request Body

Response Body

200application/json

400

401

404

`application/json`