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.
The input schema defines the fields and data types your tool accepts. You can build the schema in two ways depending on how complex your validation requirements are.
Choose a schema mode
Select the Schema mode that your tool will use:
- Manual: Use the visual field builder to add properties one at a time. Supports basic data types, validations, and required/optional flags. Recommended for simple schemas with straightforward field requirements. Manual schema creation displays a limited set of validation options
- JSON: Paste or edit raw JSON schema directly. JSON schema allows you to add more validations. Supports the full set of JSON schema validation keywords available in the library. Recommended when you need more complex validations such as anyof, oneOf, allOf, $defs/$ref, if/then/else, uniqueItems, multipleOf
Important
Switching from JSON back to Manual removes any JSON schema keywords that the visual editor doesn't support. A confirmation dialog appears before you switch.
The supported field data types include string, number, boolean, object, or array. You can create nested fields if needed.
Build the schema in Manual mode
- Click + icon to add a property. You can add multiple properties.
- Enter a property name and and select a Data type from the drop down list.
For each schema you have the following options:
- Additional settings: Click the gear icon to open Additional settings and configure validations
- Add property: Click the + icon to create a new property
- Delete property: Click the delete icon to remove a property
You can nest fields inside object or array properties to represent structured data.
Step3 - Mock Tool input
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.