JMESPath Data Extraction Event

The JMESPath Data Extraction Event allows users to transform JSON data using JMESPath queries. This powerful event enables structured extraction and transformation of JSON data into different formats, making it ideal for data preparation and integration workflows.

Overview (with Examples)

This event enables users to:

Define input JSON data from static sources or previous workflow steps.

{
  "people": [
    {"name": "John", "age": 30, "city": "New York"},
    {"name": "Alice", "age": 25, "city": "Boston"},
    {"name": "Bob", "age": 35, "city": "Chicago"}
  ]
}

Create JMESPath queries to extract and transform specific elements.

{
  "count": length(people),
  "names": people[*].name,
  "cities": people[*].city,
  "adults": people[?age > `25`].name
}

Generate transformed JSON output for use in subsequent workflow steps.

{
  "count": 3,
  "names": ["John", "Alice", "Bob"],
  "cities": ["New York", "Boston", "Chicago"],
  "adults": ["John", "Bob"]
}

JMESPath is a query language for JSON that allows you to extract and transform elements from a JSON document. Learn more at jmespath.org (opens in a new tab).

Configuring a JMESPath Data Extraction Event

1️⃣ Basic Configuration

Title & Description – Provide a meaningful name and description for the event.
Event Type – Select "JMESPath Data Extraction" from the event type dropdown.

📌 Outcome: Establishes the event's identity and purpose within the workflow.

2️⃣ Define Input JSON Data

Select Input Source:
- Static JSON – Enter or paste JSON directly into the input field.
- Carry from Previous Step – Use JSON output from a previous workflow node.

📌 Outcome: Provides the JSON data that will be transformed by the JMESPath query.

3️⃣ Create JMESPath Query

Enter JMESPath Query – Write the query that will transform your JSON.
Test Query (Optional) – Use the test functionality to preview the transformation results.

Common JMESPath patterns:

locations[*].name - Extract all location names
people[?age > 18].name - Extract names of people over 18
{count: length(items), names: items[*].name} - Create a new structure

📌 Outcome: Defines how the input JSON will be transformed into the desired output format.

4️⃣ Save & Validate

Save Configuration – Finalize the event setup.
Validate Transformation – Ensure the output meets your requirements.

📌 Outcome: The system applies the JMESPath query to transform the input JSON when the event is triggered.

Summary

The JMESPath Data Extraction Event provides a powerful way to transform JSON data structures within your workflows. By leveraging JMESPath's query capabilities, you can extract specific information, restructure data, and prepare it for downstream processing without writing custom code

Filter Event JSON Contract Event