This guide explains how to extract values from incoming JSON payloads in our platform using JSON Paths. JSON Paths allows you to navigate nested objects and arrays, filter values, and convert structured data into usable formats for your workflows.
You can use this when mapping incoming data in the webhook producer endpoint.
Searching in Arrays of Objects
Example Path
data.prices.[?enabled=false&start_date=2025-03-20].type
How it works
data.prices → Selects the prices array inside the data object.
[?enabled=false&start_date=2025-03-20] → Filters the array to only include objects where:
enabled is false
start_date equals 2025-03-20
.type → Returns the value of the type property from the matching objects.
Supported Filter Operators
When searching in arrays, you can use:
= equals
!= not equals
> greater than
>= greater than or equal
< less than
<= less than or equal
Example with Operators
Example Path
data.prices.[?enabled=false&start_date>=2025-03-20].type
This returns the type for all prices where enabled is false and start_date is on or after 2025-03-20.
Use case
Extract pricing information for specific conditions — e.g., disabled offers starting on or after a certain date.
Accessing by Array Index
Example Path
data.marketing.0.title
How it works
data.marketing → Selects the marketing array.
.0 → Gets the first object in the array (zero-indexed).
.title → Returns the title property.
Use case
Retrieve the first marketing message or campaign name from an ordered list.
Flattening Arrays to Simple Lists
Example Path
data.products.ean
How it works
data.products → Selects the products array.
.ean → Extracts the ean property from each object.
Returns a flat array of EAN strings for direct use.
Use case
Convert a list of product objects into a clean array of product identifiers for matching products to your briefing item.
Tips for Building JSON Paths
Always check your JSON payload structure before building a path.
Use filtering operators to narrow results in nested arrays.
Date comparisons require the exact stored format.
Indexes start at 0.
When flattening, ensure all array items contain the targeted property.