Skip to main content
Browse Documentation

Workflow trigger

Created by r.turner, last modified by s.yearsley on 24 Sep 2020

The workflow trigger model is used within workflow event invocation requests to move a resource to another state or perform a workflow action.

Properties

Name Type Format Description
language string   The language of the target entry variation (if applicable).
version string {Major}.{Minor} The version number of the target resource.
event string {workflowStateId}.{workflowEventId} The workflow event to invoke.
data object   Data to include with the workflow event invocation. Each event type may have different properties that can be included.

Example

This example shows a workflow trigger to invoke a submit event for an entry.

{
    "language": "en-GB",
    "version": "2.3",
    "event": "draft.submit",
    "data": {
        "message": "Have updated the final paragraph"
    }
}