Skip to main content
Browse Documentation

Workflow trigger

Created by r.turner, last modified by zengenti on 15 Jun 2021

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


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.


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"
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.