{{ my_var }}

{{ format_address(address, {company: true, format: 'html'}) }}

{{ my_var | upcase }} (makes the variable uppercase)

Filters can take arguments such as:

{{ my_var | times(10) }} (multiplies the variable by 10)

You can use multiple filters like:

{{ my_var | upcase | truncate(30) }} (makes uppercase and truncates the string)

{% if my_num > 20 and my_num <= 100 %}
  {# put your code here #}
{% endif %}

{% if my_string not in my_array %}
  {# put your code here #}
{% endif %}

{% if my_bool == false %}
  {# put your code here #}
{% endif %}

There is a shorthand version of the "if" statement called "ternary". Usage examples:

{{ condition ? returns_if_true : returns_if_false }}
{{ "auto" in "arigato automation" ? "It's automated!" : "Not automated..." }} prints "It's automated!"
{{ my_num <= 0 ? "Less than or equal to zero" : "Greater than zero" }}

{% for key, value in my_hash %}
  Key: {{ key }}
  Value: {{ value }}
{% endfor %}

You can add an else tag to control what happens when the array is empty.

{% for value in my_array %}
  {# values here #}
{% else %}
  {# my_array is empty #}
{% endfor %}

{% set my_string = "new string" %}
{% set my_array = [1, 2, 3, 4] %}

You can also "capture" a chunk of text by using a set and endset tag.

{% set my_long_text %}
  <p>
    This will set multiple lines of text into the "my_long_text" variable.
  </p>
{% endset %}

{{ my_string ~ " appended text" }}
{% set my_new_string = "prepended " ~ my_var ~ " appeneded" %}

{% set company_info = {
  name: "Bonify, LLC",
  contact: "support@bonify.io",
  "key with spaces": "some value",
} %}

Hash values can be accessed like:
{{ company_info.contact }} or {{ company_info["key with spaces"] }}

A simple array could look like:

{% set colors = ["red", "blue", "green"] %}

{{ my_var | to_json }}

{% if customer.email matches '/^[a-zA-Z0-9._%+-]+@(?:[a-zA-Z0-9-]+\.)?(google|yahoo)\.[a-zA-Z]{2,}$/i' %}
   true
{% else %}
   false
{% endif %}

{{ data | debug }}

{{ "tomato" | contains("tom") }} is TRUE
      
{{ "Apple" | contains("ap") }} is FALSE

{{ "tomato" | icontains("tom") }} is TRUE
      
{{ "apple" | icontains("AP") }} is TRUE

{{ "Arigato is amazing.\\nBonify is a bunch of geniuses." | nl2br }}

Prints:

Arigato is amazing.<br />
Bonify is a bunch of geniuses.'

{{ string_thats_getting_encoded_and_annoying_me | raw }}

{{ 'bonify' | upper }} Prints: "BONIFY"

{{ 'BONIFY' | lower }} Prints: "bonify"

{{ "now" | date("m/d/Y") }} becomes 11/13/2024
{{ "-1 month" | date("m/d/Y") }} becomes 10/13/2024
{{ "last year" | date("Y") }} becomes 2023
{{ "now" | date("l, F jS g:iA") }} becomes Wednesday, November 13th 10:54AM
{{ "yesterday 1AM" | date("l, F jS g:iA") }} becomes Tuesday, November 12th 1:00AM
{{ "next thursday 12PM" | date("l, F jS g:iA") }} becomes Thursday, November 14th 12:00PM

Timezone Example:

{{ "today 12pm America/New_York" | date("m/d/Y g:iA", "Australia/Sydney") }} becomes 11/14/2024 4:00AM

{{ object.created_at | date_modify("+2 days") | date("m/d/Y") }} Adds two days to the created time.
{{ object.created_at | date_modify("+10 minutes") | date("m/d/Y G:i:s") }} Adds ten minutes to the created time.
{{ object.created_at | date_modify("+6 months") | date("m/d/Y") }} Adds six months to the created time.

{% set my_array = "one two three" | split(" ") %} becomes an array of ["one", "two", "three"].

{{ my_var | default("my default value") }} Prints "my default value" if my_var is empty.

{{ object.tags_array | to_json }} becomes a JSON string ['tag 1', 'tag 2'].

{% set my_var = "['red','blue']" | from_json %} (my_var becomes an array).

{% set my_var = '{"name":"John Doe","age":"36"}' | from_json(true) %} (converts the JSON string to an associative array).
{{my_var["name"]}} Outputs "John Doe".

{{ "Acme's Product Title!" | to_handle }} becomes "acmes-product-title".

{{ some_html|striptags }}
{{ some_html|striptags('<br><p>') }}

{% set item = "Some words then
More words on another line." %}
{{ item | stripnewlines }}

Prints: "Some words then More words on another line."

{% set bad_string = "  bunch of text with space on the ends     " %}
 {{ bad_string  | strip }}
Prints: "bunch of text with space on the ends"

{{ "One\nTwo\nThree" | strip_newlines }}} becomes OneTwoThree.

{{ "No <strong>html</strong> tags" | strip_html }} becomes "No html tags".

{{ " has whitespace " | trim }} becomes "has whitespace".

{{ "My really long string" | truncate(5) }} becomes "My re..."

{{ "My really long string" | truncatewords(2) }} becomes "My really..."

{{ "Arigato" | append(" Automation") }} becomes "Arigato Automation".

{{ "Automation" | prepend("Arigato ") }} becomes "Arigato Automation".

{{ "Example String" | downcase }} becomes "example string".

{{ "Example String" | upcase }} becomes "EXAMPLE STRING".

{{ "example string" | capitalize }} becomes "Example string".

{{ "example string" | title }} becomes "Example String".

{{ 'path-seg*ment' | url_encode }}                  Prints "path-seg%2Ament"
{{ 'string with spaces' | url_encode }}             Prints "string%20with%20spaces"
{{ {'param': 'value', 'foo': 'bar'} | url_encode }} Prints "param=value&foo=bar"

{{ "https%3A%2F%2Fwww.bonify.io" | url_decode }} becomes "https://www.bonify.io".

{{ "example string" | length }} prints "14".

{{ "one two three" | replace({"one": "1", "two": "2"}) }} prints "1 2 three".

product.images[0] | image_url("icon") }} Use a predefined size name.
{{ product.images[0] | image_url("icon_cropped") }} Predefined size name and also crop to the size.
{{ product.images[0] | image_url("50x50") }} Specify a max-width and max-height (no cropping).
{{ product.images[0] | image_url("x500") }} Specify a max-height of 500.
{{ product.images[0] | image_url("100x100", "center") }} Specify a size and crop to "center".
{{ product.images[0] | image_url({width:100, height: 100, crop: "center"}) }} Pass a hash of keyed properties.

{% if product | is_type("product") %}
    This is a product object.
{% endif %}

{% if "my_string" | is_type("string") %}
    This is a string.
{% endif %}

{% if customer.last_order | is_type("order") %}
    Customer has a valid "Last Order" object.
 {% endif %}

{% apply inline_css %}
<html>
    <head>
        <style>
            p { color: red; }
        </style>
    </head>
    <body>
        <p>Hello CSS!</p>
    </body>
</html>
{% endapply %}

<html>
    <body>
        <p style="color:red;">Hello CSS!</p>
    </body>
</html>

{%apply inline_css %}
{% apply inky_to_html%}
<style>
  .test { text-align: center;}
  .row { width: 650px; }
  table {width: 100%;}
</style>
<row>
  <columns>put some content here</columns>
  <columns>hello world</columns>
</row>
<row>
  <columns class="test">Some secondary content</columns>
</row>
<row>
  <columns>{{ product.title }}</columns><columns>{{ product.updated_at }}</columns>
</row>
{% endapply %}
{% endapply %}

{% apply inky_to_html %}
<container>
  <row>
    <columns>Put content in me!</columns>
  </row>
</container>
{% endapply %}

<html>

<head></head>

<body>
  <table align="center" class="container">
    <tbody>
      <tr>
        <td>
          <table class="row">
            <tbody>
              <tr>
                <th class="small-12 large-12 columns first last">
                  <table>
                    <tbody>
                      <tr>
                        <th>Put content in me!</th>
                        <th class="expander"></th>
                      </tr>
                    </tbody>
                  </table>
                </th>
              </tr>
            </tbody>
          </table>
        </td>
      </tr>
    </tbody>
  </table>
</body>

</html>

{{ "603 123 9876" | format_phone("US") }} is +16031239876
      
{{ "0778 1419999" | format_phone("GB") }} is +447781419999

{{ 10 | at_least(12) }} becomes "12".
{{ 20 | at_least(12) }} becomes "20".

{{ 10 | at_most(12) }} becomes "10".
{{ 20 | at_most(12) }} becomes "12".

{{ 6.03 | ceil }} becomes "7".

{{ 6.03 | floor }} becomes "6".

{{ max(1, 3, 2) }} becomes "3".
{{ max([1, 3, 2]) }} becomes "3".
{{ max({2: "e", 1: "a", 3: "b", 5: "d", 4: "c"}) }} becomes "e".

{{ min(1, 3, 2) }} becomes "1".
{{ min([1, 3, 2]) }} becomes "1".
{{ min({2: "e", 1: "a", 3: "b", 5: "d", 4: "c"}) }} becomes "a".

{{ 1234.56 | number_format(0, "", "") }} becomes "1235".
{{ 12 | number_format(2) }} becomes "12.00".
{{ 1234.56 | number_format(2, ".", ",") }} becomes "1,234.56".
{{ 1234.56 | number_format(1, ",", ".") }} becomes "1.234,6".

{{ 10 | plus(10) }} becomes "20".

{{ 20 | minus(10) }} becomes "10".

{{ 4 | times(3) }} becomes "12".

{{ 10 | divided_by(2) }} becomes "5".

{% if 9 is divisible by(3) %}
    ...
{% endif %}

{{ 10 | percent(20) }} becomes "2".

{{ 10 | discount(20) }} becomes "8".

{{ 8 | reverse_discount(20) }} becomes "10".

{{ "tomato" | contains("tom") }} is TRUE
      
{{ "Apple" | contains("ap") }} is FALSE

{% set vehicles = [
  {"make": "honda", "model": "accord"},
  {"make": "ram", "model": "1500"},
] %}
vehicles | map("make") becomes ["honda", "ram"].
vehicles | map("model") becomes ["accord", "1500"].

{% set vehicles = [
  {"make": "honda", "model": "accord"},
  {"make": "honda", "model": "civic"},
  {"make": "ram", "model": "1500"},
  {"make": "mercedes-benz", "model": "c450"}
] %}
{{ vehicles | where("make", "honda") | map("model") | join(", ") }} returns "accord, civic".

{{ ['one','two','three'] | join(" and ") }} becomes "one and two and three".

{{ ['one','two','three','four'] | slice(1, 2) | join(", ") }} becomes "two, three".

Example with arrays:
{% set values = [1, 2] %}
{% set values = values|merge(['apple', 'orange']) %}

values now contains [1, 2, 'apple', 'orange']

Example with hashes:
{% set items = { 'apple': 'fruit', 'orange': 'fruit', 'ram': 'unknown' } %}
{% set items = items|merge({ 'ram': 'car', 'honda': 'car' }) %}

items now contains { 'apple': 'fruit', 'orange': 'fruit', 'ram': 'car', 'honda': 'car' }

{{ [8,4,5,1] | sort | join(", ") }} becomes "1, 4, 5, 8".
{{ [8,4,5,1] | sort | reverse | join(", ") }} becomes "8, 5, 4, 1".

{{ ['one','','two','three'] | compact | join(", ") }} becomes "one, two, three".

{{ ['one','two','three'] | first }} prints "one".

{{ ['one','two','three'] | last }} prints "three".

{{ ['one','two','three'] | length }} prints "3".

{{ ['one','two','three'] | reverse | join(", ") }} prints "three, two, one".

{% set days = {
  one: "Monday",
  two: "Tuesday",
  three: "Wednesday"
} %}
{{ days | keys | join(", ") }} prints "one, two, three".

{% for i in range(0, 3) %}
  {{ i }},
{% endfor %}

Prints "0, 1, 2, 3"

{% for i in range(0, 6, 2) %}
    {{ i }},
{% endfor %}

Prints "0, 2, 4, 6"

{{ random(['apple', 'orange', 'citrus']) }}   Might print "orange"
{{ random('ABC') }}                           Might print "C"
{{ random() }}                                Might print "15386094" (works as the native PHP mt_rand function)
{{ random(5) }}                               Might print "3"
{{ random(50, 100) }}                         Might print "63"

{{ "bonify" | sha1 }} prints "2d13762cd0ff7f3fb889d78b5ea07930396742ea".

{{ "bonify" | sha256 }} prints "f08f30e7c133c0d762dd0129f038547b5004756bd6d27ee1f5bc8cd4a89425c9".

{{ "bonify" | hash('sha256') }} prints "f08f30e7c133c0d762dd0129f038547b5004756bd6d27ee1f5bc8cd4a89425c9".

{{ get_type("my_string") }} prints "string".
{{ get_type(1234) }} prints "integer".
{{ get_type(product) }} prints "product".
{{ get_type({key:"value"}) }} prints "hash".

{% set result = RUN_ACTION("shopify_api_request", {
  method: "GET",
  path: "orders",
  data: {limit: 5},
  format: "order",
}) %}

{% for order in result.response %}
  {% do QUEUE_ACTION("order_add_tags", {
    resource: order,
    tags: ["a", "b", "c"]
  }) %}
{% endfor %}

An example using context and Twig tokens:

{# Fetch products using an API request and then add tags based on product type and vendor... #}
{% for p in result.response %}
  {% do RUN_ACTION("product_add_tags", {
    resource: p,
    tags: ["{{ my_item.product_type }}:{{ my_item.vendor }}"],
    context: {
      my_item: p
    }
  }) %}
{% endfor %}

{# Queue up two actions for a product: product_add_tags and set_metafield #}
{% do QUEUE_ACTION("product_add_tags", {
  resource: product,
  tags: ["a", "b", "c"]
}) %}

{% do QUEUE_ACTION("set_metafield", {
  resource: product,
  namespace: "custom_fields",
  key: "my_text_field",
  value: "my string value"
}) %}

{# Get 5 orders that we want to run through a workflow... #}
{% set result = RUN_ACTION("shopify_api_request", {
  method: "GET",
  path: "orders",
  data: {limit: 5},
  format: "order",
}) %}

{# Send each order to an order-based workflow. #}
{% for order in result.response %}
  {% do QUEUE_WORKFLOW(12345, order) %}
{% endfor %}

{# Send orders to a "Custom" workflow which accepts an HTTP Request object type. #}
{% for order in result.response %}
  {% do QUEUE_WORKFLOW(12345, order | as("http_request")) %}
{% endfor %}

{# Get 5 orders. #}
{% set result = RUN_ACTION("shopify_api_request", {
  method: "GET",
  path: "orders",
  data: {limit: 5},
  format: "order",
}) %}

{# Update a customer note asynchronously. #}
{% do QUEUE_ACTION("shopify_api_request", {
  method: "PUT",
  path: "customers/{{ customer.id }}",
  data: {customer: {note: "Updating my customer note!"}},
  format: "customer"
}) %}

{# Get the first 10 products. List of their titles. Show the query costs. #}
{% set graph_ql = "{
  products(first:10){
    edges{
      node{
        title
        id
        legacyResourceId
      }
    }
  }
}"%}

{% set resp = RUN_ACTION('shopify_graphql_request', {
    query: graph_ql
}) %}

Results:
{% for n in resp.response.data.products.edges %}
    {{ n.node.title }}
{% endfor %}

Requested Query Cost: {{ resp.response.extensions.cost.requestedQueryCost }}
Actual Query Cost: {{ resp.response.extensions.cost.actualQueryCost }}

{# Update the product description through the updateProduct mutation. Debug the response. #}
{% set graph_ql = 'mutation productUpdate($input: ProductInput!) {
  productUpdate(input: $input) {
    product {
      title
      description
    }
    userErrors {
      field
      message
    }
  }
}' %}

{% set resp = RUN_ACTION('shopify_graphql_request', {
    query: graph_ql,
    variables: {
        'input': {
            'id': product.admin_graphql_api_id,
            'descriptionHtml': '<span>New description for the product</span>'
        }
    }
}) %}

{{ resp | debug }}

You can paginate through results using the after parameter.
Note that there are strict Shopify API limits. Custom Action also has limits to the number of times you can run an action in a single request.

{% set query %}
{
  products(first:250) {
    edges {
     	node {
        id
        title
      }
    }
    pageInfo{
      hasNextPage
      endCursor
    }
  }
}
{% endset %}

{% set hasNextPage = true %}
{% for i in 0..999 if hasNextPage %}

  {% set result = RUN_ACTION('shopify_graphql_request', {
    query: query,
    after: {products: cursor}
  }) %}

  {% set pageInfo = result.response.data.products.pageInfo %}

  {% for item in result.response.data.products.edges %}
    {{ item.node.id }}: {{ item.node.title }}
  {% endfor %}

  {% set hasNextPage = pageInfo.hasNextPage %}
  {% set cursor = pageInfo.endCursor %}
{% endfor %}

You can paginate through nested results as well:

{% set products_query %}
{
  products(first:5, query:"price:>100") {
    edges {
     	node {
        id
        title
      }
    }
    pageInfo{
      hasNextPage
      endCursor
    }
  }
}
{% endset %}

{% set metafields_query %}
{
  product(id: "PRODUCT_ID") {
    metafields(first:50) {
      edges {
        node {
          namespace
          key
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
}
{% endset %}

{% set hasNextPage = true %}
{% for i in 0..999 if hasNextPage %}

  {% set result = RUN_ACTION('shopify_graphql_request', {
    query: products_query,
    after: {products: cursor}
  }) %}

  {% set pageInfo = result.response.data.products.pageInfo %}

  {% for item in result.response.data.products.edges %}
    {{ item.node.title }} metafields:

    {% set m_hasNextPage = true %}

    {% for j in 0..999 if m_hasNextPage %}

      {% set m_result = RUN_ACTION('shopify_graphql_request',{
        query: metafields_query | replace({'PRODUCT_ID': item.node.id}),
        after: {metafields: m_cursor}
      }) %}

      {% set m_pageInfo = m_result.response.data.product.metafields.pageInfo %}

      {% for m in m_result.response.data.product.metafields.edges %}
        {{ m.node.namespace }}: {{m.node.key}}
      {% endfor %}

      {% set m_hasNextPage = m_pageInfo.hasNextPage %}
      {% set m_cursor = m_pageInfo.endCursor %}

    {% endfor %}
  {% endfor %}

  {% set hasNextPage = pageInfo.hasNextPage %}
  {% set cursor = pageInfo.endCursor %}
{% endfor %}

{% set result = RUN_ACTION("http_request", {
  method: "GET",
  url: "https://api.my-custom-api.org/v1/resource",
  data: {key: "value"},
  allow_error_codes: [404],
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{ shop.database.my_api_key }}"
  }
}) %}

{% if result.response.status_code == 200 %}
  {# Things are good #}
  {% set return_objects = result.response.body | from_json %}
  Got this many objects returned: {{ return_objects | length }}
{% elseif result.response.status_code == 404 %}
  {# Resource not found #}
{% else %}
  {# Something went wrong! #}
{% endif %}

{# Queue an HTTP Request to run asynchrounsly #}
{% do QUEUE_ACTION("http_request", {
  method: "PUT",
  url: "https://api.my-custom-api.org/v1/resource/123",
  data: {update_this: "field"},
  headers: {
    "Content-Type": "application/json",
    "Api-Key": "123123123"
  }
}) %}

{# This assumes the "product" object is in context. Such as in a Product Created workflow. #}
{% do RUN_ACTION("product_add_to_collections", {
  resource: product,
  collection_ids: [123123123]
}) %}

{# This assumes the "product" object is in context. Such as in a Product Created workflow. #}
{% do QUEUE_ACTION("product_remove_from_collections", {
  resource: product,
  collection_ids: [123123123]
}) %}

{# Set a products "Product Category" based on ID. #}
{% do RUN_ACTION("product_set_category", {
  resource: product,
  id: "gid://shopify/TaxonomyCategory/ap-2-3"
}) %}

{# You can display matching category IDs by passing a "name" argument. #}
{% do RUN_ACTION("product_set_category", {
    debug: true,
    resource: product,
    name: "sweatshirts"
}) %}

[
    {
        "title": "Set the taxonomy category for a product",
        "debug": {
            "debug": true,
            "name": "sweatshirts",
            "is_test": true,
            "possible_categories": [
                {
                    "id": "gid://shopify/TaxonomyCategory/aa-1-1-7-4",
                    "fullName": "Apparel & Accessories > Clothing > Activewear > Activewear Sweatshirts & Hoodies > Sweatshirts"
                },
                {
                    "id": "gid://shopify/TaxonomyCategory/aa-1-13-14",
                    "fullName": "Apparel & Accessories > Clothing > Clothing Tops > Sweatshirts"
                },
                {
                    "id": "gid://shopify/TaxonomyCategory/aa-1-2-9-13",
                    "fullName": "Apparel & Accessories > Clothing > Baby & Toddler Clothing > Baby & Toddler Tops > Sweatshirts"
                }
            ]
        },
    }
]

{% do RUN_ACTION("product_set_custom_product_type", {
  resource: product,
  custom_product_type: "Arigato",
}) %}

{# This assumes the "product" object is in context. Such as in a Product Created workflow. #}
{% do RUN_ACTION("product_unpublish", {
  resource: product,
}) %}

{# This assumes the "product" object is in context. Such as in a Product Created workflow. #}
{% do RUN_ACTION("product_update_description", {
  resource: product,
  description: "My new product description here."
}) %}

Example appending to the description:

{% do RUN_ACTION("product_update_description", {
  resource: product,
  description: "{{ product.body_html }}
 My appended product description here.",
}) %}

{# View available sales channels when you don't pass in the "sales_channels" arguments #}
{% do RUN_ACTION("product_publish_sales_channels", {
  resource: product
}) %}

{#
  Debug output will contain available sales channels
  [
      {
          "title": "Publish to sales channels",
          "debug": {
              "sales_channels_info": {
                  "gid://shopify/Publication/12341234": "Online Store",
                  "gid://shopify/Publication/98719871": "Point of Sale"
              },
              "user_entered_sales_channels": [],
              "sales_channels": []
          }
      }
  ]
#}

{# Pass a list of IDs to add product to multiple sales channels. #}
{% do RUN_ACTION("product_publish_sales_channels", {
  resource: product,
  sales_channels: ["gid://shopify/Publication/12341234", "gid://shopify/Publication/98719871"]
}) %}

{#
  Debug info will let you know if the entered IDs are "valid" or "invalid".
  {
    "user_entered_sales_channels": {
        "gid://shopify/Publication/12341234": "valid",
        "gid://shopify/Publication/98719871": "valid"
    },
    "sales_channels": [
        "gid://shopify/Publication/12341234",
        "gid://shopify/Publication/98719871"
    ]
  }
#}

{# View available sales channels when you don't pass in the "sales_channels" arguments #}
{% do RUN_ACTION("product_unpublish_sales_channels", {
  resource: product
}) %}

{#
  Debug output will contain available sales channels
  [
      {
          "title": "Unpublish from sales channels",
          "debug": {
              "sales_channels_info": {
                  "gid://shopify/Publication/12341234": "Online Store",
                  "gid://shopify/Publication/98719871": "Point of Sale"
              },
              "user_entered_sales_channels": [],
              "sales_channels": []
          }
      }
  ]
#}

{# Pass a list of IDs to remove product from multiple sales channels. #}
{% do RUN_ACTION("product_unpublish_sales_channels", {
  resource: product,
  sales_channels: ["gid://shopify/Publication/12341234", "gid://shopify/Publication/98719871"]
}) %}

{#
  Debug info will let you know if the entered IDs are "valid" or "invalid".
  {
    "user_entered_sales_channels": {
        "gid://shopify/Publication/12341234": "valid",
        "gid://shopify/Publication/98719871": "valid"
    },
    "sales_channels": [
        "gid://shopify/Publication/12341234",
        "gid://shopify/Publication/98719871"
    ]
  }
#}

{# Add tags to a product. #}
{% do RUN_ACTION("product_add_tags", {
  resource: product,
  tags: ["a", "b", "c"]
}) %}

{# Add tags to a product we load specifically by ID. #}
{% set p = load('product', 123123123) %}
{% do QUEUE_ACTION("product_add_tags", {
  resource: p,
  tags: ["d", "e", "f"]
}) %}

{# Remove ALL tags from a product. #}
{% do RUN_ACTION("product_remove_tags", {
  resource: product,
  tags: product.tags
}) %}

{% do RUN_ACTION("product_add_remove_tags", {
  resource: product,
  add_tags: ["a", "b"],
  remove_tags: ["c", "d"]
}) %}

{# Set a global "shop" metafield. #}
{% do RUN_ACTION("set_metafield", {
  resource: shop,
  namespace: "custom_fields",
  key: "my_string_field",
  value: "Setting a new value here!"
}) %}

{# Set a product metafield based on ID (not a resource object) #}
{% do QUEUE_ACTION("set_metafield", {
  resource_type: "products",
  resource_id: 123123123,
  namespace: "custom_fields",
  key: "my_int_value",
  value: 42,
  value_type: "integer"
}) %}

{# Set a "Volume" type metafield. Notice the additional "unit" argument. #}
{% do RUN_ACTION("set_metafield", {
  resource: product,
  namespace: "my_fields",
  key: "volume",
  value: 100,
  unit: "us_gal",
  value_type: "volume"
}) %}

{# Add and remove values from a list metafield type. #}
{% do RUN_ACTION("set_metafield", {
  resource: product,
  namespace: "my_fields",
  key: "dimension_list",
  value_type: "list.dimension",
  allow_duplicates: true,
  add_values: "1cm, 2in, 3ft",
  remove_values: "10mm, 20mm"
}) %}

{#  Set a metafield on the first variant on a product #}
{% set product = load('product', 12345) %}
{% do RUN_ACTION("set_metafield", {
  resource_type: "variants",
  resource_id: product.variants[0].id,
  namespace: "custom_fields",
  key: "my_key",
  value: "my value"
}) %}

{# Set a global "shop" database value. #}
{% do RUN_ACTION("set_database", {
  key: "list_of_things",
  value: "thing_1, thing_2, thing_3"
}) %}

{# You can then print out the value. #}
{{ shop.database.list_of_things }}

{# Set a database value based on resource_type and resource_id. #}
{% do QUEUE_ACTION("set_database", {
  resource_type: "products",
  resource_id: 123123123,
  key: "some_value",
  value: "Some Value"
}) %}

{# Set a resource's database value. #}
{% do QUEUE_ACTION("set_database", {
  resource: customer,
  key: "some_value",
  value: "Some Value"
}) %}

{% do QUEUE_ACTION("email", {
  to: shop.email,
  subject: "New order placed!",
  body: "Check out order {{ order.name }}. {{ orders_products_list(order, {format: "html"}) }}",
  plain_text: false,
  context: {order: order}
}) %}

{% do QUEUE_ACTION("sendgrid", {
  to: shop.email,
  subject: "New order placed!",
  body: "Check out order {{ order.name }}. {{ orders_products_list(order, {format: "html"}) }}",
  plain_text: false,
  context: {order: order}
}) %}

{% do QUEUE_ACTION("google_gmail", {
  to: shop.email,
  from: {
    name: "John Smith",
    email: "your_address@gmail.com"
  },
  subject: "New order placed!",
  body: "Check out order {{ order.name }}. {{ orders_products_list(order, {format: 'html'}) }}",
  plain_text: false,
  context: {order: order}
}) %}

{% do RUN_ACTION("redirect_create", {
  old_path: "/my-old-path",
  new_path: "/my-new-path"
}) %}

Example using a product handle.

{% do RUN_ACTION("redirect_create", {
  old_path: "/products/my-old-product-handle-path",
  new_path: "/products/{{ p.handle }}",
  context: {
    p: product
  }
}) %}

{% do RUN_ACTION("product_set_fields", {
  resource: product,
  fields: {
    title: "New product title",
    handle: "new-product-handle",
    tags: ["a", "b", "c"],
    category: {
      id: "gid://shopify/TaxonomyCategory/ap-2-3",
    },
  }
}) %}

{% do RUN_ACTION("product_variant_set_fields", {
  resource: product_variant,
  fields: {
    sku: "NEW-SKU",
    price: 12.99,
    requires_shipping: true,
    option1: "Blue",
    weight: 1.0,
    weight_unit: "lb"
  }
}) %}

{% do RUN_ACTION("customer_set_fields", {
  resource: customer,
  fields: {
    first_name: "David",
    tags: ["a", "b", "c"],
    note: "Awesome customer!",
    accepts_marketing: true
  }
}) %}

{% do RUN_ACTION("order_set_fields", {
  resource: order,
  fields: {
    note: "My order note.",
    tags: ["a", "b", "c"],
    shipping_address: {
      address1: "123 Acme St.",
      country: "US",
      province: "NY",
      city: "New York"
    }
  }
}) %}

{# Complete a draft order and mark it as paid. #}
{% do RUN_ACTION("draft_order_complete", {
  resource: draft_order,
}) %}

{# Completes a draft order and marks it as payment pending. #}
{% do RUN_ACTION("draft_order_complete", {
  resource: draft_order,
  payment_pending: TRUE
}) %}

{% do RUN_ACTION("draft_order_set_fields", {
  resource: draft_order,
  fields: {
    note: "My draft order note.",
    shipping_address: {
      address1: "123 Acme St.",
      country: "US",
      province: "NY",
      city: "New York"
    }
  }
}) %}

{# Add tags to a draft_order. #}
{% do RUN_ACTION("draft_order_add_tags", {
  resource: draft_order,
  tags: ["a", "b", "c"]
}) %}

{# Add tags to a draft_order we load specifically by ID. #}
{% set draft_order = load('draft_order', 123123123) %}
{% do QUEUE_ACTION("draft_order_add_tags", {
  resource: draft_order,
  tags: ["d", "e", "f"]
}) %}

{# Remove ALL tags from a draft_order. #}
{% do RUN_ACTION("draft_order_remove_tags", {
  resource: draft_order,
  tags: draft_order.tags
}) %}

{% do RUN_ACTION("draft_order_add_remove_tags", {
  resource: draft_order,
  add_tags: ["a", "b"],
  remove_tags: ["c", "d"]
}) %}

{% do RUN_ACTION("inventory_item_set_fields", {
  resource: inventory_item,
  fields: {
    cost: 12.99,
    tracked: true
  }
}) %}

{# This assumes "product" object is in context, such as in a Product Updated workflow. #}
{% do RUN_ACTION("delete_resource", {
  resource: product
}) %}

Example specifying a resource_type and resource_id.

{% do RUN_ACTION("delete_resource", {
  resource_type: "products",
  resource_id: 1234
}) %}

{% do RUN_ACTION("customer_add_note", {
  resource: customer,
  note: "My note."
}) %}

{# Add tags to a customer. #}
{% do RUN_ACTION("customer_add_tags", {
  resource: customer,
  tags: ["a", "b", "c"]
}) %}

{# Add tags to a customer we load specifically by ID. #}
{% set customer = load('customer', 123123123) %}
{% do QUEUE_ACTION("customer_add_tags", {
  resource: customer,
  tags: ["d", "e", "f"]
}) %}

{# Remove ALL tags from a customer. #}
{% do RUN_ACTION("customer_remove_tags", {
  resource: customer,
  tags: customer.tags
}) %}

{% do RUN_ACTION("customer_add_remove_tags", {
  resource: customer,
  add_tags: ["a", "b"],
  remove_tags: ["c", "d"]
}) %}

{% do RUN_ACTION("customer_update_sms_consent", {
  resource: customer,
  opt_in_level: "CONFIRMED_OPT_IN",
  marketing_state: "SUBSCRIBED",
}) %}

{% do RUN_ACTION("customer_update_email_consent", {
  resource: customer,
  opt_in_level: "CONFIRMED_OPT_IN",
  marketing_state: "SUBSCRIBED",
}) %}

{% do RUN_ACTION("customer_send_invite", {
  resource: customer,
}) %}

{% do RUN_ACTION("log", {
  title: "Product Info",
  body: product | debug
}) %}

{% do RUN_ACTION("ifttt", {
  event: "my_custom_ifttt_event_name",
  value1: "Some valuable data",
  value2: "Some more valuable data",
  value4: "Even more valuable data",
}) %}

{% do RUN_ACTION("order_add_note", {
  resource: order,
  note: "This is an important note for this order.",
}) %}

{% do RUN_ACTION("order_add_note_attribute", {
  resource: order,
  attributes: [
    { name: "my_attribute_name", value: "A value for this attribute." },
    { name: "my_second_attribute", value: "Another attribute value." }
  ]
}) %}

{% do RUN_ACTION("order_add_line_item", {
    resource: order,
    variant_id: "47406627881249",
    quantity: 1,
    allow_duplicates: false,
    inventory_location: "123456789"
}) %}

{# Add tags to a order. #}
{% do RUN_ACTION("order_add_tags", {
  resource: order,
  tags: ["a", "b", "c"]
}) %}

{# Add tags to a order we load specifically by ID. #}
{% set order = load('order', 123123123) %}
{% do QUEUE_ACTION("order_add_tags", {
  resource: order,
  tags: ["d", "e", "f"]
}) %}

{# Remove ALL tags from a order. #}
{% do RUN_ACTION("order_remove_tags", {
  resource: order,
  tags: order.tags
}) %}

{% do RUN_ACTION("order_add_remove_tags", {
  resource: order,
  add_tags: ["a", "b"],
  remove_tags: ["c", "d"]
}) %}

{% do RUN_ACTION("order_cancel", {
  resource: order,
  reason: "other",
  restock: true,
  void: true,
  notify_customer: false,
}) %}

{% do RUN_ACTION("order_capture_payment", {
  resource: order,
}) %}

{% do RUN_ACTION("order_close", {
  resource: order,
}) %}

{% do RUN_ACTION("order_open", {
  resource: order,
}) %}

{% do RUN_ACTION("order_refund", {
  resource: order,
  currency: shop.currency,
  note: "We messed this up.",
  restock_type: "no_restock",
  refund_shipping: false,
  notify_customer: false,
}) %}

{% do RUN_ACTION("order_void_transactions", {
  resource: order,
}) %}

{% do RUN_ACTION("order_fulfill", {
  resource: order,
  message: "Leave at the front gate.",
  notify_customer: false,
  tracking_info: {
    "number": "1234567890",
    "url": "https://www.example.com",
    "company": "usps"
  }
}) %}

{% do RUN_ACTION("order_create_risk", {
  resource: order,
  recommendation: "investigate",
  message: "Arigato Automation detected an issue with this order.",
}) %}

Example given a single order line item.

{% do RUN_ACTION("line_item_fulfill", {
  resource: line_item,
  message: "Leave at the front gate.",
  notify_customer: false,
  tracking_info: {
    "number": "1234567890",
    "url": "https://www.example.com",
    "company": "usps"
  }
}) %}

Example fulfilling a specific line item in an order.

{% for line_item in order.line_items %}
  {% if line_item.title | contains("Digital") %}
    {% do RUN_ACTION("line_item_fulfill", {
      resource: line_item,
    }) %}
  {% endif %}
{% endfor %}

{% do RUN_ACTION("fulfillment_cancel", {
  resource: fulfillment,
}) %}

{% do RUN_ACTION("fulfillment_update_tracking", {
  resource: fulfillment,
  notify_customer: false,
  tracking_info: {
    "number": "1234567890",
    "url": "https://www.example.com",
    "company": "usps"
  }
}) %}

{% do RUN_ACTION("fulfillment_order_fulfill", {
  resource: fulfillment_order,
  message: "Leave at the front gate.",
  notify_customer: false,
  tracking_info: {
    "number": "1234567890",
    "url": "https://www.example.com",
    "company": "usps"
  }
}) %}

{# Use the "debug" argument to display location options. Note, only valid options for the test object are returned. #}

{% do RUN_ACTION("fulfillment_order_move", {
  debug: true,
  resource: fulfillment_order
}) %}
{# The resulting debug information will be shown: #}
{
    "title": "Move a fulfillment order.",
    "location_options": {
        "61592567991": "Location Name 1 - City, State/Providence",
        "62002036919": "Location Name 2 - City, State/Providence",
        "62002069687": "Location Name 3 - City, State/Providence",
    }
}

Enter the location_id you wish to move the fulfillment order to.

{# Move a fulfillment order. #}
{% do RUN_ACTION("fulfillment_order_move", {
      debug: true,
      resource: fulfillment_order,
      location_id: "61592567991"
}) %}

{# The resulting confirmation debug information will be shown: #}
{
    "title": "Move a fulfillment order.",
    "location_id": "Location Name 1 - City, State/Providence [61592567991]"
}

{# Hold a fulfillment order. #}
{% do RUN_ACTION("fulfillment_order_hold", {
      resource: fulfillment_order,
      reason: "awaiting_payment",
      reason_notes: "The customer has not paid for their order."
}) %}

{% do RUN_ACTION("fulfillment_order_release_hold", {
  resource: fulfillment_order,
}) %}

{% do RUN_ACTION("fulfillment_order_line_item_fulfill", {
  resource: line_item,
  quantity: 1,
  message: "Leave at the front gate.",
  notify_customer: false,
  tracking_info: {
    "number": "1234567890",
    "url": "https://www.example.com",
    "company": "usps"
  }
}) %}

{% set product = load('product', 123456789) %}

{% set image = product.images[0] %}

{% do RUN_ACTION("product_image_set_alt", {
  resource: image,
  alt: "New alt tag",
}) %}

{% set image = product.variants[0].image %}

{% do RUN_ACTION("product_image_set_alt", {
  resource: image,
  alt: "edited variant version",
}) %}

{% do RUN_ACTION("product_publish", {
  resource: product,
}) %}

{% do RUN_ACTION("product_variant_set_price", {
  resource: product_variant,
  price: 25.00
}) %}

{% do RUN_ACTION("product_variant_discount", {
  resource: product_variant,
  discount: 10,
  discount_type: "percent",
  reverse: false,
  reverse_safe: false,
  once: true,
}) %}

{% do RUN_ACTION("collection_publish", {
  resource: collection,
}) %}

{% do RUN_ACTION("collection_unpublish", {
  resource: collection,
}) %}

{% do RUN_ACTION("collection_update_image", {
  resource: collection,
  image: "http://cdn.shopify.com/path/to/the/image.jpeg",
  alt: "The alt text for the new image"
}) %}

{% do RUN_ACTION("collection_set_fields", {
  resource: collection,
  fields: {
    title: "New collection title",
    body_html: "New collection description.",
    handle: "new-collection-handle",
  }
}) %}

{# View available sales channels when you don't pass in the "sales_channels" arguments #}
{% do RUN_ACTION("collection_publish_sales_channels", {
  resource: collection
}) %}

{#
  Debug output will contain available sales channels
  [
      {
          "title": "Publish to sales channels",
          "debug": {
              "sales_channels_info": {
                  "gid://shopify/Publication/12341234": "Online Store",
                  "gid://shopify/Publication/98719871": "Point of Sale"
              },
              "user_entered_sales_channels": [],
              "sales_channels": []
          }
      }
  ]
#}

{# Pass a list of IDs to add collection to multiple sales channels. #}
{% do RUN_ACTION("collection_publish_sales_channels", {
  resource: collection,
  sales_channels: ["gid://shopify/Publication/12341234", "gid://shopify/Publication/98719871"]
}) %}

{#
  Debug info will let you know if the entered IDs are "valid" or "invalid".
  {
    "user_entered_sales_channels": {
        "gid://shopify/Publication/12341234": "valid",
        "gid://shopify/Publication/98719871": "valid"
    },
    "sales_channels": [
        "gid://shopify/Publication/12341234",
        "gid://shopify/Publication/98719871"
    ]
  }
#}

{# View available sales channels when you don't pass in the "sales_channels" arguments #}
{% do RUN_ACTION("collection_unpublish_sales_channels", {
  resource: collection
}) %}

{#
  Debug output will contain available sales channels
  [
      {
          "title": "Unpublish from sales channels",
          "debug": {
              "sales_channels_info": {
                  "gid://shopify/Publication/12341234": "Online Store",
                  "gid://shopify/Publication/98719871": "Point of Sale"
              },
              "user_entered_sales_channels": [],
              "sales_channels": []
          }
      }
  ]
#}

{# Pass a list of IDs to remove collection from multiple sales channels. #}
{% do RUN_ACTION("collection_unpublish_sales_channels", {
  resource: collection,
  sales_channels: ["gid://shopify/Publication/12341234", "gid://shopify/Publication/98719871"]
}) %}

{#
  Debug info will let you know if the entered IDs are "valid" or "invalid".
  {
    "user_entered_sales_channels": {
        "gid://shopify/Publication/12341234": "valid",
        "gid://shopify/Publication/98719871": "valid"
    },
    "sales_channels": [
        "gid://shopify/Publication/12341234",
        "gid://shopify/Publication/98719871"
    ]
  }
#}

Example sending a message with an emoji icon and link.

{% do RUN_ACTION("slack", {
  to: "#new-orders",
  body: "Whoop whoop! :moneybag: You've made a sale! <{{ order.admin_url }}|View Order>",
}) %}

If you don't know the current board_id and list_id to use, you can find them in a couple different ways.
To see your Trello board information as JSON you can navigate to a Trello board and add .json to the end of the URL.
For example, if your URL is https://trello.com/b/7Cfi181ca/my-new-orders, go to https://trello.com/b/7Cfi181ca/my-new-orders.json.
In the resulting JSON output you can find the board ID, the list IDs, and the label IDs.

Another method is to use the inline Test Center which can fetch your boards and lists and display them to you.

1. First, in the Test Center, select a resource (if Test Center is not available in your workflow type then you will need to follow the method listed above).
2. In the Custom Action, enter the example code below.
3. When the blue icon appears, hover over it to see the available board IDs.

{# Use the "debug" argument to display board_id information. #}
{% do RUN_ACTION("trello", {
debug: true
}) %}

{# The resulting debug information will be shown: #}
[
  {
     "debug": {
       "instructions": "Enter a "board_id" to view list_id options and label options.",
       "boards": {
         "5e1234659335f61273e62": "My Board One",
         "5b1234cc771d3f3c0c4dd45a": "My Board Two",
         "5f12346b6872c714ef797b52": "My Board Three",
       }
     }
   }
]

Enter a board ID to see available list IDs, label IDs, member IDs, and custom field information in that board.

{# Entering a "board_id" with "debug" will show available lists and labels. #}
{% do RUN_ACTION("trello", {
  debug: true,
  board_id: "5e1234659335f61273e62"
}) %}

{# The resulting debug information will be shown: #}
[
  {
    "debug": {
            "board_id": "Board Name [60590164abedee8ca3012aaa]",
            "title": "Enter a title for your card",
            "description": "Enter a description for your card",
            "due_date": "An optional due date for your card",
            "lists": {
                "60590164abedee8ca301aab": "List one",
                "60590164abedee8ca301aac": "List two",
                "60590164abedee8ca301aad": "List three"
            },
            "labels": {
                "60590452e106b4821ee6f80": "Label 1",
                "6059044cde192c45b714e75": "Label 2",
                "60590164184d2c731bf19a8": "Label 3",
            },
            "members": {
                "6054fc8dd4b7681b92402ad1": "John Smith",
                "6054fc8dd4b7681b92402ad2": "Bob Campbell",
            },
            "custom_fields": {
                "605904e7331b193fe1e61088": {
                    "name": "Text Type",
                    "type": "text"
                },
                "605904efee5989388de7672e": {
                    "name": "Check Box",
                    "type": "checkbox"
                },
                "60590503c6cd893898e1673f": {
                    "name": "Date Test",
                    "type": "date"
                },
                "605b534ffa2ee2891a0f5016": {
                    "name": "Dropdown",
                    "type": "list",
                    "options": {
                        "605b534ffa2ee2891a0f5017": "Option 1"
                        "605b534ffa2ee2891a0f5018": "Option 2"
                        "605b534ffa2ee2891a0f5019": "Option 3"
                    }
                }
            },
            "attachment: {
                "http://path/to/file.png",
                "http://path/to/second/file.jpg",
                "http://path/to/link",
                }

        }
    }
]

You can now configure your action with the correct board_id, list_id, labels (array of label IDs), members (array of member IDs), and a custom_fields hash. All custom field values must be a string.

{% do RUN_ACTION("trello", {
  board_id: "YOUR_BOARD_ID",
  title: "New Order {{ order.name }}",
  description: "Order needs processing by date.",
  list_id: "YOUR_LIST_ID",
  labels: ["YOUR_LABEL_ID_1", "YOUR_LABEL_ID_2"],
  members: ["YOUR_MEMBER_ID_1", "YOUR_MEMBER_ID_2"],
  custom_fields: {
      "YOUR_CUSTOM_FIELD_ID_1":"A text field value",
      "YOUR_CUSTOM_FIELD_ID_2":"true",
      "YOUR_CUSTOM_FIELD_ID_3":"+3 Days",
      "YOUR_CUSTOM_FIELD_ID_4":"YOUR_CUSTOM_FIELD_ID_4"
  },
  attachment: ["http://path/to/file.png", "http://path/to/second/file.jpg", "http://path/to/link"],
  due_date: "+5 weekdays",
}) %}

{% do RUN_ACTION("twilio", {
  to: "16031238888",
  body: "The message.",
  opt_out: "Reply STOP to unsubscribe."
}) %}

{% do RUN_ACTION("zapier", {
  url: "https://hooks.zapier.com/hooks/catch/123123/abcdefg/",
  body: "{test: true}"
}) %}

{% do RUN_ACTION("zapier", {
  url: "https://hooks.zapier.com/hooks/catch/123123/abcdefg/",
  resource: order,
}) %}

{% do RUN_ACTION("google_sheets", {
  url: "https://docs.google.com/spreadsheets/d/abc123/edit#gid=TAB_ID",
  rows: [
    ["row_1_A", "row_1_B", "row_1_C"],
    ["row_2_A", "row_2_B", "row_2_C"],
  ]
}) %}

{% do RUN_ACTION("klaviyo_subscribe", {
  list_id: "KL123",
  customer: customer,
}) %}

{% do RUN_ACTION("klaviyo_subscribe", {
  list_id: false,
  customer: order.customer,
  customer_properties: {
    first_name: "Overrides the default customer first_name",
    city: "Overrides the default address city",
    CustomProp1: "A custom property.",
    ShopifyTags: order.customer.tags_array,
    CustomCreatedAtDate: order.customer.created_at,
  }
}) %}

{% do RUN_ACTION("klaviyo_track_event", {
  customer: order.customer,
  event: "Arigato Example",
  event_properties: {
    foo: "bar",
    tags: order.tags_array,
  },
  customer_properties: {
    CustomProp1: "Hello, World!",
  }
}) %}

{% do RUN_ACTION("mailchimp_subscribe", {
  list_id: "abc12345678",
  email: customer.email,
}) %}

{% do RUN_ACTION("mailchimp_subscribe", {
  list_id: "abc12345678",
  email: customer.email,
  tags: customer.tags,
  merge_fields: {
    FNAME: customer.first_name,
    LNAME: customer.last_name,
    MY_CUSTOM_FIELD_VALUE: "Custom Value!"
    ADDRESS: {
      addr1: customer.default_address.address1,
      addr2: customer.default_address.address2,
      city: customer.default_address.city,
      state: customer.default_address.province_code,
      country: customer.default_address.country_code,
      zip: customer.default_address.zip
    },
  }
}) %}

{% do RUN_ACTION("mailchimp_unsubscribe", {
  list_id: "abc12345678",
  email: customer.email,
}) %}

{% do RUN_ACTION("shopify_flow", {
  "String One": "String data 1",
  "String Two": "String data 2",
  "String Three": "String data 3",
  "String Four": "String data 4",
  "String Five": "String data 5",
  "Number One": "Number data 1",
  "Number Two": "Number data 2",
  "Number Three": "Number data 3",
  "Boolean One": true,
  "Boolean Two": false,
  "Boolean Three": true,
  "URL": "https://bonify.io",
  "Email": "support@bonify.io",
}) %}

Below are some examples on how to debug for more information on what is available for your Airtable integration. For more field level specific information, visit the Airtable field documentation.

{# Use the "debug" argument to display base_id information. #}
{% do RUN_ACTION("airtable_insert_record", {
  debug: true
}) %}

{# The resulting debug information will be shown: #}
[
    {
        "debug": {
            "instructions": "Enter a "base_id" to view table_id options.",
            "bases": {
                "5e1234659335f61273e62": "Base One",
                "5b1234cc771d3f3c0c4dd45a": "Base Two",
                "5f12346b6872c714ef797b52": "Base Three",
            }
        }
    }
]

{# Use the "debug" argument to display table_id information. #}
{% do RUN_ACTION("airtable_insert_record", {
  debug: true,
  base_id: "5b1234cc771d3f3c0c4dd45a"
}) %}

{# The resulting debug information will be shown: #}
[
    {
        "debug": {
            "base_id": "Base Name [5b1234cc771d3f3c0c4dd45a]",
            "instructions": "Enter a "table_id" to view field options.",
            "tables": {
                "60590164abedee8ca301aab": "Table one",
                "60590164abedee8ca301aac": "Table two",
                "60590164abedee8ca301aad": "Table three"
            }
        }
    }
]

{# Use the "debug" argument to display field information. #}
{% do RUN_ACTION("airtable_insert_record", {
  debug: true,
  base_id: "5b1234cc771d3f3c0c4dd45a",
  table_id: "60590164abedee8ca301aac"
}) %}

{# The resulting debug information will be shown: #}
[
    {
        "debug": {
            "base_id": "Base Name [5b1234cc771d3f3c0c4dd45a]",
            "table_id": "Table Name [60590164abedee8ca301aac]",
            "fields": {
                "Field One": {
                    "id": "605b534ffa2ee2891a0f5017",
                    "type": "Single Line Text"
                },
                "Field Two": {
                    "id": "605b534ffa2ee2891a0f5018",
                    "type": "Rich Text"
                },
                "Field Three": {
                    "id": "605b534ffa2ee2891a0f5019",
                    "type": "Number"
                },
            }
        }
    }
]

Example inserting a record.

{% do RUN_ACTION("airtable_insert_record", {
  base_id: "YOUR_BASE_ID",
  table_id: "YOUR_TABLE_ID",
  fields: {
      "Name": "John Doe",
      "Email": "john@mail.com",
      "Phone": "123-456-7890"
   }
}) %}

{{ workflow_vars["my_text_var"].value }}

{{ global_vars["my_text_var"].value }}

HTML Values
Any text-based variable that contains HTML can be rendered as raw HTML by using the raw string filter.
For example, given the following value: <strong>This is HTML</strong>

{{ workflow_vars["my_html_string"].value }} {# Will escape HTML characters like: <strong>This is HTML</strong>  #}
{{ workflow_vars["my_html_string"].value | raw }} {# Prints HTML characters like: <strong>This is HTML</strong>  #}

Checkboxes Variable Type

{{ workflow_vars["my_checkboxes"].value }} {# Prints out a pipe-delimited string of values, such as "1|2|3" #}
{{ workflow_vars["my_checkboxes"].values }} {# An array of values, such as [1, 2, 3] #}
{{ workflow_vars["my_checkboxes"].values | join(', ') }} {# Prints out the values as "1, 2, 3" #}

JSON Variable Type
Given the following JSON string:

{
  "product": {"title": "My Product Title"}
}

{{ workflow_vars["my_json"].value | debug }} {# Prints out the entire parsed JSON object. #}
{{ workflow_vars["my_json"].value.product.title }} {# Prints "My Product Title" #}

Key/Value Variable Type
This variable type is similar to JSON, but more structured and only allows top-level keys, such as:

{
  "vendor_a": "admin@vendor_a.com",
  "Vendor B": "admin@vendor_b.com"
}

{{ workflow_vars["my_kv_field"].value | debug }} {# Prints out the entire parsed JSON object. #}
{{ workflow_vars["my_kv_field"].value.vendor_a }} {# Prints "admin@vendor_a.com" #}
{# If your key contains any spaces or special characters you need to use quoted syntax: #}
{{ workflow_vars["my_kv_field"].value["Vendor B"] }} {# Prints "admin@vendor_b.com" #}

Date Variable Type
The Date type stores a date as a string in whatever format you specify.
However, you can change the format of the date and manipulate it like this:

{{ workflow_vars["date"].value }} {# A date string, such as "2022-01-28" #}
{{ workflow_vars["date"].value | date("m/d/Y") }} {# Prints "1/28/2022" #}
{{ workflow_vars["date"].value | date_modify("+1 year") | date("m/d/Y") }} {# Prints "1/28/2023" #}

{{ render_variable(workflow_vars["test_variable"], {format: 'plain', label: true, description: true ) }}
{# Will print the following: #}
Label: Test Variable
Description: The testing text field.
Value: The value of the variable

{{ render_variables(workflow_vars, {format: 'plain', label: true, description: true ) }}
{# Will print the following: #}
Label: Test Variable 1
Description: The testing text field.
Value: The value of the variable

Label: Test Variable 2
Description: The second testing text field.
Value: The value of the second variable