Transforms

Transforms reshape an action's data after it is fetched. Declare a post_transforms: block — an array of transform functions applied in order.

actions:
  - name: AddAttribute
    http:
      url: https://jsonplaceholder.typicode.com/todos/10
    post_transforms:
      - extract_value: ".body"
      - add_attribute:
          env: production

The filter transform reuses the assertion vocabulary to keep only matching elements. Every transform and its fields are listed below.

Transform

Field	Type	Description
rename_attributes	Map<string, string> (nullable)	Rename attributes (keys) within a JSON object. Maps old attribute names to new attribute names.
remove_attributes	Array<string> (nullable)	Remove specified attributes from the JSON object. Provides an array of attribute names to exclude.
keep_attributes	Array<string> (nullable)	Keep only specified attributes, removing all others. Provides an allowlist of attribute names.
move_attributes	Map<string, string> (nullable)	Move attributes from one location to another. Maps source path to destination path.
rename_keys	Map<string, string> (nullable)	Rename keys at the root level of a JSON object. Maps old key names to new key names.
remove_keys	Array<string> (nullable)	Remove specified keys from the JSON object. Provides an array of key names to exclude.
bcrypt	BcryptTransform (nullable)	Hash a value using bcrypt for secure password storage. Supports custom cost factor.
add_attribute	object (nullable)	Add new attributes to the JSON object with specified key-value pairs.
return_row	number (nullable)	Return a specific row from a result set by index (0-based).
extract_value	string (nullable)	Extract a single value from the response using a JSON path.
extract_array	TransformExtractArray (nullable)	Extract an array from a JSON response with options for flattening and deduplication.
extract_with_json_path	string (nullable)	Extract data using a JSON path expression. Shortcut for simple extractions.
extract_with_jq	string (nullable)	Extract data using jq filter syntax for complex JSON transformations.
extract_with_regex	ExtractWithRegex (nullable)	Extract values from a string using regex capture groups.
add_jwt	AddJWT (nullable)	Add a JWT token to the response with configurable expiration and payload.
read_jwt	ReadJWT (nullable)	Read and decode a JWT token to extract its payload.
numerics	Array<string> (nullable)	Convert string fields to numeric types. Provides an array of field names to convert.
group_by	Array<string> (nullable)	Group array elements by specified fields. Used for aggregation operations.
generate_password	TransformPasswordGen (nullable)	Generate a secure random password with customizable options for length and character types.
replace_values	TransformReplaceValues (nullable)	Replace values in strings or arrays with support for regex and multiple replacements.
flatten	TransformFlatten (nullable)	Flatten nested objects into a single level with configurable key separators.
b64_decode	string (nullable)	Decode a Base64-encoded string.
b64_decode_as_json	string (nullable)	Decode a Base64-encoded string and parse as JSON.
b64_encode	TransformConfig (nullable)	Encode a value to Base64. Can be a direct string or custom transform configuration.
yaml_to_json	TransformConfig (nullable)	Convert YAML-formatted string to JSON.
nested_transforms	Map<string, Array<Transform>> (nullable)	Apply nested transforms to specific keys. Maps keys to arrays of transform operations.
math	TransformMath (nullable)	Perform mathematical operations on numeric values with expressions.
filter	TransformFilterSearch (nullable)	Filter array elements based on specified conditions.
generate_bytes	GenerateBytes (nullable)	Generate random bytes with specified length.
encrypt_value	EncryptValue (nullable)	Encrypt a value using AES-256-GCM encryption.
s3_generate_presigned_url	S3GeneratePresignedURL (nullable)	Generate a presigned URL for S3 file access.
encode_uri	TransformConfig (nullable)	URI-encode an entire URL string.
encode_uri_component	TransformConfig (nullable)	URI-encode a single component of a URL.
decode_uri	TransformConfig (nullable)	URI-decode an encoded URL string.
decode_uri_component	TransformConfig (nullable)	URI-decode a single component of an encoded URL.
generate_slug	TransformConfig (nullable)	Generate a URL-friendly slug from a string.

TransformConfig

One of:

• string
• CustomTransform

CustomTransform

Field	Type	Description
key	string	Required.
json_path	string	Required.

TransformExtractArray

Field	Type	Description
from	string (nullable)	The JSON path to the starting array
paths	Array<string> (nullable)	Array of JSON paths to extract values from each element
flatten	boolean (nullable)	Whether to flatten nested arrays
dedupe	boolean (nullable)	Whether to remove duplicates

TransformFilterSearch

Field	Type	Description
target	string (nullable)
conditions	Map<string, Test>	Required. Conditions to filter items in the array.

TransformFlatten

Field	Type	Description
key_separator	string	Required.
prefix	string (nullable)
target	string (nullable)

TransformMath

Field	Type	Description
target	string (nullable)
expressions	Map<string, string>	Required.
to_string	boolean (nullable)
decimal_places	number (nullable)
eval_type	MathEvalType (nullable)

TransformPasswordGen

Field	Type	Description
key	string	Required.
length	number	Required.
numbers	boolean (nullable)
lowercase_letters	boolean (nullable)
uppercase_letters	boolean (nullable)
symbols	boolean (nullable)
spaces	boolean (nullable)
exclude_similar_characters	boolean (nullable)
strict	boolean (nullable)

TransformReplaceValues

Field	Type	Description
target_value	string	Required.
target_key	string (nullable)
find_str	string (nullable)
new_str	string (nullable)
regex	string (nullable)
values	Array<string> (nullable)

BcryptTransform

Field	Type	Description
key	string (nullable)
value	string (nullable)
jq	string (nullable)
cost	number (nullable)

AddJWT

Field	Type	Description
key	string	Required.
secret	string	Required.
exp	string (nullable)
data	any	Required.

ReadJWT

Field	Type	Description
key	string	Required.
token	string	Required.

EncryptValue

Field	Type	Description
key	string	Required.
data	string	Required.
secret_key	string	Required.
nonce	string	Required.

GenerateBytes

Field	Type	Description
key	string	Required.
length	number	Required.

ExtractWithRegex

Field	Type	Description
value	string	Required.
expr	string	Required.
keys	Array<string>	Required.

S3GeneratePresignedURL

Field	Type	Description
bucket	string	Required.
file_key	string	Required.
expiration_secs	number	Required.
endpoint	string	Required.
region	string	Required.
access_key_id	string	Required.
secret_access_key	string	Required.
key	string	Required.
json_path	string (nullable)

MathEvalType

Type: string — one of: int, float, string, bool

DataType

Type: string — one of: text, json, csv, xml