Workflows Changelog

The workflows changelog is used to present the chronological list of records describing the history of workflow step changes for a single workflow which is linked to a specified entry. The changelog includes the associated entry, the new workflow step, and the timestamp of the event that occurred.

Workflows changelog record schema

Field	Type	Required	Description
entity	Link	true	A reference to the entry for which the workflow was executed
event	String	true	Maybe one of the following values: `completed`, `created`, `deleted`, `stepChanged`
eventAt	Date	true	Timestamp of the event that occured
eventBy	Link	true	A reference to user or app definition which triggered this stepAnnotations
stepId	String	true	ID of the step after the event was triggered
stepName	String	true	Name of the step after the event was triggered
workflow	Link	true	A reference to the associated workflow
workflowDefinition	Link	true	A reference to the associated workflow definition

Get all workflow changelog records

This endpoint allows to query records in the workflows changelog with certain filters. The filters are via multiple query parameters which are described in the endpoint specifications.

The resulting list is sorted by the event date in a descending order, i.e. the first item is the most recent one.

Permissions

Every user can query a workflows changelog if they have read access to the specified entry.