Tool input defines the structure and format of data exchanged between systems. It acts as a blueprint, ensuring consistency by specifying required fields, data types, and validation rules. This reduces errors, simplifies troubleshooting, and makes your tools easier to build, test, and maintain.
Configuring tool input helps you:
-
Send data to another system (for example, create a ticket)
-
Update or delete records (for example, modify a user profile)
-
Connect systems and automate workflows (for example, sync CRM data)
A properly configured Tool input ensures your data is structured correctly, validated, and ready for the next step.
Name* (required): Name your Tool input so that you can easily reference it from other parts of the application.
Description (optional): Describe your Tool input so that users can quickly understand what it is doing without reading through all the configuration fields.
Define the data format that your tool will use. You can:
-
Paste a JSON schema
-
Add fields manually using the interface
The supported field data types include string, number, boolean, object, or array. You can create nested fields if needed.
Note
JSON schema allows you to add more validations. Manual schema creation displays a limited set of validation options.
You can add multiple properties by providing a name and data type. Click and select the appropriate Data type from the drop-down menu.
For each schema you have the following options:
-
Property configuration (optional): Click the gear icon to add a description and select Required if needed.
-
Add property: Click the + icon to create a new property.
-
Delete property: Click the delete icon to remove a property.
The mock Tool input auto-populates sample data based on the schema, however, providing your own mock data can be helpful. Use mock data to:
-
Preview input and output
-
Test Tool invocation scenarios
-
Validate configurations
-
Reset to the integrator.io canonical format
All mock data must be valid JSON, as the platform automatically validates JSON structure.
Caution
Tool input data is stored permanently. Do not include personal or sensitive information.
Reset to sample data: This field populates based on the schema, overwriting any user modifications.
Click Send to review Input and Output. If the input doesn’t match the configured validation error is thrown.The output is selected by default and displays the JSON payload you'll see in subsequent Transformations and errors in case of any validation errors.
Transformation allows you to modify the incoming data before passing it to the next tool step. You can rename a field, remove a field, and restructure a record.
Transformation rules are applied in the order they appear; drag and drop them to change the order.
How to create a transformation
-
In the right column, select the field from your tool input data that you want to use.
-
In the left column, enter the name of the field you want to create.