Action objects
Last updated
Was this helpful?
Last updated
Was this helpful?
An action object defines work to be performed by an , after the task is fully finished rendering. Action objects are most easily generated using the .
An action object is a plain JSON object, having the following structure:
The action type is always a string, having a value that corresponds to (e.g. "shopify"
, or "http"
).
Action options vary by action type. Depending on the action type, its options may be another complete object, or an array, or a scalar value.
Actions may optionally include meta information, annotating the action with any JSON value.
This information could be purely for record-keeping, making it easy to determine why an action was rendered, or to add helpful context:
Or, this information could be used to facilitate complex task flows, in concert with a subscription to mechanic/actions/perform (see ). An action's meta information can supply followup task runs with information about state, allowing the task to cycle between different phases of operation.