Actions

In Mechanic, an action is an instruction for performing work that has an effect. Actions are generated by tasks, in response to events. Each action has a type, specifying the class of operation to be performed, and options, providing specifics about what that operation will do.

Actions are defined by tasks using action objects, which are simple JSON objects specifying an action's type and options. Action objects can be constructed using the action tag.

Action types

An action type determines the class of operation to be performed. While actions may vary greatly, there are only a few action types:

Action

Purpose

Cache

Performing operations on the store's Mechanic cache

Echo

Debugging; displays the options that it is provided, with no side-effects

Email

Sending transactional email

Event

Generating custom user events

Files

Generating files of various types, storing them at a temporary Mechanic-provided URL

FTP

Performing FTP file uploads and downloads

HTTP

Performing HTTP requests

Shopify

Sending requests to the Shopify Admin API, supporting both REST and GraphQL