Create a node & select Data Connected Node

Accessing Response Metadata

Every Actions API response in our system is decorated with a special metadata key named _zt_meta. This allows you to access technical details about the API request directly within the response variable, alongside your actual data.

This is particularly useful for building logic branches based on the success or failure of a call (e.g., distinguishing between a 200 OK and a 404 Not Found).

Available Metadata Fields

The _zt_meta object currently provides the following information:

• response.code (Integer): The HTTP status code returned by the API (e.g., 200, 404, 500).

• response.body (String): The raw response body, only set when there is a request error (non-2xx response).

The Metadata Structure

The metadata object is automatically injected at the root of your action variable:

How to use it in Logic

You can reference the status code in Logic Nodes, Expression Nodes, or Scripts using standard dot notation:

• Syntax: actions.[alias]._zt_meta.response.code

• Example: actions.get_products._zt_meta.response.code

Important Note on Key Collisions

Because _zt_meta is injected directly into your response payload, please ensure your upstream API does not use _zt_meta as a key. If the external API returns a key with this exact name, it may be overwritten by the system metadata.

API Response Structure & Object Wrapping

To ensure consistent access to response data and metadata, our system requires that all API responses be formatted as a JSON Object at the root level.

However, we recognize that many external APIs return Lists (Arrays) or simple values (Strings/Integers) as their root response. To support these endpoints without errors, we automatically apply a standard wrapper to any response that is not already an object.

How it works

When your Action receives a response:

1. If the Root is an Object: The data is passed through as-is.

2. If the Root is an Array or Primitive: We wrap the data inside a parent object using the key value.

Examples

Scenario A: The API returns an Object (No change) If the external API returns a standard object, your variable structure remains exactly as the API sent it.

• Raw API Response: {"id": 123, "name": "Alice"}

• Variable Access: actions.get_user.name returns "Alice"

Scenario B: The API returns an Array (Wrapped) If the external API returns a list, we wrap it and you must include .value in your path to access the array.

• Raw API Response: [{"id": 1}, {"id": 2}]

• System Transformation:

  { "value": [{"id": 1}, {"id": 2}], "_zt_meta": { ... } }

• Variable Access:

  • actions.get_list.value[0].id returns 1

  • Incorrect: actions.get_list[0].id (This will error because the root is now an object)

Scenario C: The API returns a Primitive (Wrapped)

• Raw API Response: "Success"

• System Transformation:

  { "value": "Success", "_zt_meta": { ... } }

• Variable Access: actions.get_status.value returns "Success"

Use the Connected Object in the Data Connected Node