HowTo's
Create - WorkflowAction for trigger
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Data": {
"Key": null, // Will be generated automatically by the API
"ParentWorkflowKey": "V29ya2Zsb3cJMjUxMTEzMDAwMDAwMDAzMzg2NTAzV0YJMA==", // The API will validate that a workflow with this key exists
"Action": 1, // Fixed enum: 1 = Trigger workflow
"Conditions": {
// The API will validate that the entity is supported and that the field exists for that entity
"AbEntry/Udf/$NAME(Next KYC Date)": {
"$EQ": "$OFFSET(D+10, $TODAY())" // This condition is evaluated daily. It triggers the parent workflow for each AbEntry where the KYC date is 10 days from the evaluation date
}
}
}
}
}Create - WorkflowAction for branching
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Data": {
"Key": null, // Will be generated automatically by the API
"ParentWorkflowKey": "V29ya2Zsb3cJMjUxMTEzMDAwMDAwMDAzMzg2NTAzV0YJMA==", // When the workflow with this key is completed, this action will be evaluated
"Action": 2, // Fixed enum: 2 = Branch workflow
"Conditions": {
// Currently, only conditions based on Workflow/Result are supported
"Workflow/Result": {
"$EQ": "A new policy is needed" // If this result is selected, the operation will be executed
}
},
"Operations": [
{
"Type": 1, // For Action = 2, only operation type 1 is supported: StartWorkflow
"Data": "V29ya2Zsb3cJMjUxMTEzMDAwMDAwMDAzNjM0NjgzV0YJMA==" // Key of the workflow to start once the parent workflow is completed
}
]
}
}
}Create - WorkflowAction for update fields
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Data": {
"Key": null, // Will be generated automatically by the API
"ParentWorkflowKey": "V29ya2Zsb3cJMjUxMTEzMDAwMDAwMDAzMzg2NTAzV0YJMA==", // When the workflow with this key is completed, this action will be evaluated
"Action": 3, // Fixed enum: 3 = Update field
"Operations": [
{
"FieldName": "AbEntry/Udf/$NAME(Next KYC Date)", // The API will validate that the entity is supported and that the field exists for that entity
"Type": 3, // Depends on the entity and action (see field options for valid values). For Action = 3 and this date field, 3 = Add Days
"Data": "5" // Number of days to add to the current value of the field (in this case, 5 days)
}
]
}
}
}MetaData
Read WorkflowAction metadata (simple)
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": 1
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/WorkflowAction"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}Read WorkflowAction metadata (more)
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"Schema": {
"Scope": {
"Fields": {
"Key": 1,
"Alias": 1,
"Type": 1,
"Name": 1,
"AppliesTo": 1,
"Sortable": 1,
"Queryable": 1,
"Mandatory": 1,
"Attributes": 1,
"DisplayValue": 1
}
},
"Criteria": {
"SearchQuery": {
"Key": {
"$TREE": "/WorkflowAction"
}
}
}
},
"Compatibility": {
"SchemaObject": "1.0"
}
}FieldOptions
Read WorkflowAction FieldOptions - Action
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"WorkflowAction": {
"FieldOptions": {
"Action": [
{
"Key": 1,
"DisplayValue": 1
}
]
}
}
}Read WorkflowAction FieldOptions - Operations/FieldName
Returns available WorkflowAction update-field targets for Operations/FieldName.
Notes:
- Action must be 3 (UpdateField).
- Response values are qualified field keys (for example AbEntry/CreationDate).
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"WorkflowAction": {
"FieldOptions": {
"Operations/FieldName": [
{
"Key": 1
}
]
},
"Data": {
// Based on the Action, the API returns the allowed values for Operations/FieldName (currently limited to date and string fields from AbEntry)
"Action": 3 // Only Action 3 supports Operations/FieldName
}
}
}Read WorkflowAction FieldOptions - Operations/Type
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"WorkflowAction": {
"FieldOptions": {
"Operations/Type": [
{
"Key": 1,
"DisplayValue": 1
}
]
},
"Data": {
// Based on the Action and FieldName (when applicable), the API returns the valid values for Operations/Type
"Action": 3, // Only Actions 2 and 3 support operations; this value determines which options are returned
"Operations": {
"FieldName": "AbEntry/LastContactDate" // Field for which the available operation types are requested
}
}
}
}WorkflowAction CRUD
Create - WorkflowAction
// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Data": {
"Key": null, // Will be generated automatically by the API
"ParentWorkflowKey": "BASE64_WORKFLOW_KEY", // The workflow that triggers or owns this action (must exist)
"Action": 2, // Action type:
// 1 = Trigger workflow (scheduled/conditional)
// 2 = Branch workflow (based on Workflow/Result)
// 3 = Update field
"Conditions": {
// Optional depending on Action:
// - Required for Action = 1 (evaluated periodically)
// - Required for Action = 2 (typically Workflow/Result)
// - Not applicable for Action = 3
"Workflow/Result": {
"$EQ": "Some result value" // Example condition; structure depends on the action type
}
},
"Operations": [
{
// Optional for Action = 2 and Required for Action = 3
"Type": 1,
// Operation type
// Valid values depend on:
// - Action
// - FieldName (if applicable)
// Retrieve valid options from:
// → FieldOptions: Operations/Type
"FieldName": "AbEntry/Udf/$NAME(Some Field)",
// Required for Action = 3 (Update field)
// Ignored for Action = 2
// Retrieve valid fields from:
// → FieldOptions: Operations/FieldName
"Data": "VALUE"
// Meaning depends on Type:
// - For StartWorkflow → workflow key
// - For field updates → value or operation parameter (e.g., number of days to add)
}
]
}
}
}Update - WorkflowAction
// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Data": {
"Key": "V29ya2Zsb3dBY3Rpb24JNjQ=", // Mandatory
// ParentWorkflowKey and Action can't be updated
// If conditions or operations are included new ones will replace original values if are valid
"Conditions": {
// Optional depending on Action:
// - Required for Action = 1 (evaluated periodically)
// - Required for Action = 2 (typically Workflow/Result)
// - Not applicable for Action = 3
"Workflow/Result": {
"$EQ": "Some result value" // Example condition; structure depends on the action type
}
},
"Operations": [
{
// Required for Action = 2 and Action = 3
"Type": 1,
// Operation type
// Valid values depend on:
// - Action
// - FieldName (if applicable)
// Retrieve valid options from:
// → FieldOptions: Operations/Type
"FieldName": "AbEntry/Udf/$NAME(Some Field)",
// Required for Action = 3 (Update field)
// Ignored for Action = 2
// Retrieve valid fields from:
// → FieldOptions: Operations/FieldName
"Data": "VALUE"
// Meaning depends on Type:
// - For StartWorkflow → workflow key
// - For field updates → value or operation parameter (e.g., number of days to add)
}
]
}
}
}Read - WorkflowAction
// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Scope": {
"Fields": {
"Key": 1,
"ParentWorkflowKey": 1,
"Action": 1,
"Conditions": 1,
"Operations": [
{
"FieldName": 1,
"Type": 1,
"Data": 1
}
]
}
},
"Criteria": {
"SearchQuery": {},
"Top": 3
}
}
}Delete - WorkflowAction
// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
"WorkflowAction": {
"Data": {
"Key": "V29ya2Zsb3dBY3Rpb24JNjQ=" // Mandatory
}
}
}