Workflow event
An event that can occur to an entry while it is in the current workflow state. This may cause the entry to transition to a different workflow state or stay in the same state.
To publish an entry with a custom workflow, one or more events on one or more states must transition to the sysWorkflow state, which is a system state. Once the entry is in this state, it will either be published immediately, or if a publishing schedule is set for the entry, scheduled for publishing.
System states and are not included in the workflow, however the sysUpdate event can be overridden in any custom state. This will allow users approving an entry to make changes to the entry in the approval state, enabling them to fix spelling mistakes and grammatical errors rather than declining the entry. This can be achieved by adding a sysUpdate event to the approval state but using the same groupId as used for approve/decline.
Properties
Example
This example shows an event that is part of workflow state (not shown for simplicity).
{
"id": "submit",
"name": {
"en-GB": "Send for approval"
},
"auditText": {
"en-GB": "Submitted"
},
"description": {
"en-GB": "Send the entry for approval"
},
"transitionTo": "awaitingApproval",
"color": "green",
"groupId": "submitRevoke",
"uiAction": "navigateToEntryListing",
"validate": true,
"parameters": [
{
"id": "message",
"name": {
"en-GB": "Add an optional message for the approver"
},
"dataType": "string",
"dataFormat": null,
"description": {
"en-GB": "The message included with the entry submission"
},
"default": null,
"validations": {},
"editor": {
"id": "multiline",
"instructions": {
"en-GB": "Optionally include a message to let an approver understand your changes"
},
"properties": null
}
}
]
}