Create a new workflow
Creates a new workflow for automated response actions
Header Parameters
- SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
- application/json
Request Body required
Workflow creation request
- name string required
Possible values:
non-emptyand<= 255 charactersWorkflow name
- description string
Possible values:
<= 1000 charactersWorkflow description
- 201
- 400
- 409
Workflow created successfully
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage stringresult object
id stringUnique workflow identifier
org_id stringOrganization ID
name stringPossible values:
non-emptyand<= 255 charactersWorkflow name
description stringPossible values:
<= 1000 charactersWorkflow description
status stringPossible values: [
draft,active,paused,deleted]Current state of a workflow
created_by stringUser ID who created the workflow
created_at date-timeWorkflow creation timestamp
updated_by stringUser ID who last updated the workflow
updated_at date-timeLast update timestamp
activated_at date-timeWhen workflow was first activated
paused_at date-timeWhen workflow was paused
last_executed_at date-timeLast execution timestamp
execution_count integerTotal execution count
success_count integerSuccessful execution count
failure_count integerFailed execution count
latest_configuration_id stringID of the latest configuration version
latest_configuration_version integerLatest configuration version number
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
],
"result": {
"id": "string",
"org_id": "string",
"name": "string",
"description": "string",
"status": "draft",
"created_by": "string",
"created_at": "2005-12-24T18:29:30.033157Z",
"updated_by": "string",
"updated_at": "2005-12-24T18:29:30.033157Z",
"activated_at": "2005-12-24T18:29:30.033157Z",
"paused_at": "2005-12-24T18:29:30.033157Z",
"last_executed_at": "2005-12-24T18:29:30.033157Z",
"execution_count": 0,
"success_count": 0,
"failure_count": 0,
"latest_configuration_id": "string",
"latest_configuration_version": 0
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}