- Home
- Models
- Workflows
Workflows
Each time a response is received, the system will run through any workflows. Workflows can perform many actions, but the main actions are emailing a user, sending an SMS, assigning a label, or assigning a user.
Workflows fields
Field |
Type |
Fillable |
Reference |
id
|
Integer
|
|
|
The unique ID to identify the workflow
|
Workflows relations
campaign,
event,
form,
Workflows endpoints
GET List all Workflows /workflows toggle
Paramaters
There are no parameters for this endpoint
Example response
GET Return data for a specified Workflow /workflows/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the workflow
Paramaters
There are no parameters for this endpoint
Example response
POST Save, or update a Workflow /workflows/:id? toggle
URL slugs
- id
-
Integer
The unique ID to identify the workflow
Paramaters
- actions
-
String
An array of object actions
- after
-
String
[No documentation available]
- before
-
String
[No documentation available]
- campaign_id
-
Reference
References campaign model.
- conditions
-
String
An array of object conditions
- delay
-
String
[No documentation available]
- event_id
-
String
[No documentation available]
Required
- form_id
-
Reference
References form model.
- import_id
-
String
[No documentation available]
- name
-
String
A name to identify this workflow
- order
-
String
[No documentation available]
- requirement
-
String
String to decide on how to match conditions, either ALL, or ANY
- schedule
-
String
[No documentation available]
- stop_at
-
String
[No documentation available]
- test_mode
-
String
[No documentation available]
DELETE Delete a Workflow /workflows/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the workflow
Paramaters
There are no parameters for this endpoint