Skip to main content
Browse Documentation
HTTP - Management

Workflow event

Created by c.neale, last modified by r.saunders on 24 Sep 2021

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

NameData typeData formatDescription
idstringAn identifier for the event, which must be unique within the workflow state.
nameobjectlocalized valueThe friendly name given to the event.
descriptionobjectlocalized valueA description of the event.
auditTextobjectlocalized valueThe audit text written to the event history log for the event.
transitionTostringThe identifier for the state that the event causes the entry to transition to. If this is not specified or set to *null* then the entry will remain in the same state when this event is triggered.
groupIdstringThe identifier of the workflow [event group](event-group) which the event belongs to.
colorstringThe color to be displayed in the Contensis UI for the event.
uiActionstringThe event to be performed by the Contensis UI when an entry exits the workflow state. Currently on the value "navigateToEntryListing" is supported. The default is for no action to occur.
parametersobject[...]A list of parameters for the event.
validatebooleanfieldSpecifies if validation should occur when an author invokes this event

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
            }
        }
    ]
}