This article explains the different types of mappings available when working with tools and it focuses primarily on Tool output mapping. Understanding these differences will help you correctly structure and transform data within your tool, ensuring it flows smoothly to downstream steps or connected systems.
There are four types of mapping: import, response, results, and Tool output. Mapping data defines how your records are compared, merged, or transformed between lookups, imports, and your final Tool output schema. Click the icon to open the mapper.
-
Import mapping (import): Import mapping defines how the provided data relates to your import destination record data. You can use Mapper 1.0 or Mapper 2.0 to configure import mappings.
-
Response mapping (import): You can add response mappings to capture data returned from an import within your Tool. Response mappings allow you to insert the response data of an import back into your source record so that you can reference that data in subsequent steps of your tool.
For example, suppose an application automatically assigns customer IDs to newly imported customers and includes them in the response. In that case, you can add those field values to the source record for future use, like sending the customer ID to the tool consumer after it's created.
-
Results mapping (lookup): Results mapping is similar to response mapping, but instead of returning the response after an import, results mapping allows you to merge the resulting records returned by a lookup in your tool back into the provided data. The returned lookup records can be used later in the tool.
-
Tool output mapping (Tool output): Map your source records to the Tool output schema.
For example, to create a new customer, you must map the source record you sent (e.g., name, birthday, address) to the response you'll send after the customer is created. The response schema in this mapper is automatically generated based on the output schema in the Tool output node.
In the Tool output step, click + → Mapping to open the Mapper.
The schema can include arrays, objects, nested fields, etc., and the supported media type is JSON. You can use handlebars to supplement your mappings in cases where you have complex data requirements.
Click Auto preview or Preview to view the output schema and other details you've added to your Tool output.
For more on utilizing Mapper 2.0, see: