Options object

Only available within a task, the options object contains all values provided by merchants while configuring the task.

Each option value is itself parsed for Liquid. The options variable is not available during this pass. :)

How to access it

Use {{ options }} or {{ options.foobar }} in a task's...

• Liquid event subscriptions (see Task subscriptions)

• code

• online store JavaScript

• order status JavaScript

  For more discussion on using this object, see Task options.

What it contains

This object is always a hash. The keys always correspond to lookups (i.e. {{ options.foobar__required }}) in the task code (and elsewhere). The values are configured by the user, using a form that's automatically generated by Mechanic.

For more on using this object (and implicitly constructing the merchant-facing configuration form), see Task options.

Global and secret options

Options can also render dropdowns for selecting existing shop globals and secrets:

{{ options.shared_username__global_required }}
{{ options.api_token__secret_required }}

A global option returns the selected global's value at runtime.

A secret option returns an opaque secret reference, not the raw secret value. Mechanic turns that reference into the real value only inside supported actions and filters, such as HTTP actions, specific FTP connection fields, and signing filters like hmac_sha256 or rsa_sha256. See Globals and secrets for details.