Integration Acceptance Criteria
This page explains the essential criteria that every integration must meet to be accepted into the platform. These requirements ensure consistency, reliability, and an optimal user experience across all integrations in our ecosystem. Integrations that fail to meet any of these requirements will be rejected and must be revised before resubmission.
Whether you're building your first integration or refining an existing one, use this page as your guide to meeting our quality standards.
Ensure that every point below must be complied before submitting the integration. Incomplete integrations will not be accepted.
Following these criteria will help you create integrations that are not only functional but also intuitive, well-documented, and maintainable for long-term success. Review each section carefully and ensure full compliance before submission.
1. AI Description
Description: AI Description helps to ensure developers can quickly and clearly understand the integration’s complete functionality.
Provide a comprehensive and concise description of the integration’s capabilities.
Specify all supported Workflow Activities (e.g., sending messages, creating records, updating data).
Specify all supported Workflow Triggers (e.g., receiving events, polling APIs, monitoring changes).
Use precise, unambiguous language—avoid vague or generic statements. Emphasize practical use cases and action-oriented descriptions.
2. Trigger Configuration
Description: The Trigger configuration enables validation and debugging of triggers during setup.
Configure a comprehensive Test API specification for each Trigger, including realistic sample data that mirrors actual workflow events.
The test response should simulate a typical payload returned from the actual API.
Useful for schema preview and dynamic input mapping.
3. Asset Requirements
Description: This section ensures all visual assets contribute to a professional and consistent UI.
Provide the logo in SVG format.
Ensure the logo maintains a perfect 1:1 aspect ratio (square).
4. Input Field Configuration
Description: The input field configuration enhances usability and streamlines the developer experience for all users.
Select the most suitable field type for each parameter (e.g., use textarea for prompts or long-form text, toggles or checkboxes for boolean values, and appropriate controls for numbers, dates, etc.).
For dropdowns, autocompletes, and similar selection fields, support both static (predefined) and dynamic (API-driven) value sources to maximize flexibility.
For parameters that can accept dynamic values, set allowDynamic: true within htmlProps to enable runtime mapping.
Ensure all input fields are intuitive, semantically correct, and clearly labeled.
5. API Operation Definitions
Description: Ensure robust handling of API operations, especially for endpoints that return large or paginated datasets.
Implement pagination support according to the API’s mechanism (e.g., page-based, cursor-based, header-based, or body-based pagination). Clearly define a pagination object that matches the API’s requirements, enabling users to retrieve all available data efficiently.
6. Documentation
Description: Documentation enhances usability and provides a good developer experience for both internal and external users.
Thoroughly document authentication details in Authentication.mdx, including supported authentication types, token management, and step-by-step testing instructions.
Provide comprehensive integration documentation in Documentation.mdx, including an overview, setup and usage guides, detailed parameter explanations, known limitations, troubleshooting tips, and practical examples.
Ensure all hyperlinks are accurate, up-to-date, and direct users to relevant sections or external resources.
Set all external links to open in a new tab by adding target="_blank" for improved navigation and user experience.
7. Code Quality
Description: Good code quality avoid technical debt and redundant payloads during sync.
Ensure that all code is clean, concise, and well-organized, including only the necessary elements for functionality.
Eliminate all console/debug logs and unnecessary print statements before submission.
Remove any temporary, experimental, or commented-out code to maintain a tidy and professional codebase.
8. Coverage and Flexibility
Description: This enables advanced developers to interact with non-standard, unlisted, or edge-case APIs.
Support creation of custom resources to define reusable API domains or services.
Support creation of custom operations for flexible API calls with user-defined paths, methods, and parameters.
Ensure these features allow access to extended or undocumented endpoints, maximizing integration possibilities.
9. Activity Testing and Validation
Description: It guarantees that workflows execute reliably and consistently in both test and production environments.
Rigorously test each activity using static data: Provide hardcoded input values to verify correct schema, structure, and expected outputs.
Thoroughly test each activity with dynamic data: Use runtime values from previous workflow steps to simulate real-world scenarios and ensure robust handling of variable inputs.
Validate that all activities produce consistent results, handle errors gracefully, and accurately parse responses under various conditions.
If all the above criteria are met, you are now ready to submit the integration and proceed to the Submit page.