> For the complete documentation index, see [llms.txt](https://learn.mechanic.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.mechanic.dev/platform/liquid/objects/options.md).

# 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](/core/tasks/subscriptions.md))
* code
* online store JavaScript
* order status JavaScript

  For more discussion on using this object, see [Task options](/core/tasks/options.md).

## 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](/core/tasks/options.md).

## Global and secret options

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

```liquid
{{ 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](/platform/globals-and-secrets.md) for details.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://learn.mechanic.dev/platform/liquid/objects/options.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.