Submitting a connector for the public marketplace
Overview
This document outlines the approval process for developers submitting public connectors for inclusion in the [Public Marketplace]. The [Public Marketplace] is a platform where users can discover, install, and use a range of pre-built connectors to accelerate the onboarding process. For in-depth guides on how to build a connector, please see our connector builder section. For a demonstration video of our connector builder, watch our CEO Jim Herbert build a connector in under 5 minutes:
Submission Requirements
If you are a developer seeking to submit a public connector for inclusion in the [Public Marketplace], you must ensure that their connector meets the following requirements.
| Requirement | Summary |
|---|---|
Compliance | The connector must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights. |
Functionality | The connector must provide clear and useful functionality that adds value for users. It should be well-designed, intuitive to use, and free from significant bugs or issues. |
Quality | The connector must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the [Public Marketplace] platform. |
Security | The connector must implement appropriate security measures to protect user data and prevent unauthorised access or misuse. It should follow best practices for secure coding and data handling. |
Marketplace compatibility | The connector should be compatible with the [Public Marketplace] platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies. |
Documentation (recommended) | Developers should provide clear and comprehensive documentation for their connector, including installation instructions, usage guidelines, and troubleshooting tips if any are required. |
Submission Process
The submission process for public connectors consists of the following steps:
Step 1: Declaration of intent
Before the development of the connector commences, you are encouraged to submit in writing (to your partner manager) the following details on any connector(s) you intend to create.
| Item | Summary |
|---|---|
Developer name | The name and email address of your company or developer. |
Patchworks company profile | The Patchworks dashboard company profile name under which you will create the new connector(s). |
Connector name | The name of the connector to be displayed in the [Public Marketplace]. |
Expected completion date | If known, provide the expected completion date for development. |
Step 2: Pre-submission review
Before submitting a connector for approval, you are encouraged to conduct a thorough review of your connector to ensure it meets all requirements outlined above.
This includes testing the connector for functionality, performance, and security.
Step 3: Connector submission
Once the connector is ready, you can submit it via your account manager. The submission should include the following:
Documentation and user guides (if required)
Screenshots or demo videos (if applicable)
Contact information for the developer or support team
Step 4: Review meeting
Once the connector and associated information are submitted, the [Public Marketplace] team will schedule a review meeting with the developers. During this meeting, you should be prepared to:
Demonstrate working flows by showing data transmission between source and destination endpoints.
Review any scripts or custom components used in the connector authentication & endpoints.
Post-approval responsibilities
After a connector is approved and listed in the [Public Marketplace], you have certain responsibilities to maintain the connector's quality and compliance.
| Responsibility | Summary |
|---|---|
Updates & maintenance | You should regularly update and maintain you connector(s) to ensure it remains compatible with the [Public Marketplace] platform and any relevant changes or updates. |
Support | You must provide adequate support to users, including addressing enquiries, issues, and bug reports in a timely manner. |
Compliance | You should continue to comply with all relevant laws, regulations, and policies, and promptly address any compliance issues that arise. |
Conclusion
The approval process outlined above is designed to ensure that public connectors included in the [Public Marketplace] meet our high standards for quality, functionality, and security. By following this process and meeting our submission requirements, you can contribute to a vibrant ecosystem of third-party apps that enhance the user experience on the Patchworks platform.
For further information or assistance with the connector submission process, please refer to the [Public Marketplace] developer documentation or contact the [Public Marketplace] support team.
Last updated