Extract Key

Extract Key takes a record, or a list of records, and returns only the field you specify. It is useful when an earlier step gives you a lot of information and you only need one value, such as a customer’s email or an order total.

When to use it

• A query to your CRM returns full customer records and you only want their emails.
• You need the status field of an API response to decide what to do next.
• You want to pass an agent only the description of each product, without the other fields.

Configuration

Field	What it does
Data Input	The record or list of records you want to take the field from.
Key to Extract	The name of the field you want to keep, for example email. It must be written exactly as in the data, including upper and lower case.

Output

The Extracted Data output returns records that contain only the chosen field:

• If one record comes in and has the field, one record with that field comes out. If it does not have it, a record with an error field saying it was not found comes out.
• If a list comes in, a list with the field of every record that has it comes out. Records without the field are left out.

Example

A flow receives the day’s orders and wants to send a notice to each customer.

1. Connect the order list to Data Input.
2. In Key to Extract, type email_cliente.
3. Connect Extracted Data to the component that sends the notices.

Related components

• Extract Data: keeps several fields at once.
• Filter Data Keys: includes or excludes several fields, also inside nested fields.
• Get Value By Key: gets the value of a field.