Skip to main content
Browse Documentation
HTTP - Management

Workflow definition event

Created by c.neale, last modified by j.moore on 17 Dec 2020

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.

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.
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.
exitActionsobject[...]actionActions to be performed on the entry when the event triggers and the entry leaves the current state.
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.

Example

This example shows an event.

{
    "id": "submit",
    "name": {
        "en-GB": "Send for approval"
    },
    "description": {
        "en-GB": "Send the entry for approval"
    },
    "transitionTo": "awaitingApproval",
    "exitActions": [
        {
        "invokeAction": "validateEntry"
        }
    ],
    "color": "blue",
    "groupId": "submitRevoke",
    "uiAction": "navigateToEntryListing",
    "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
            }
        }
    ]
}