6 min read

Overview

This guide covers the steps to get a completed add-on published on the QuickNode Marketplace. It will walk you through preparing your listing details, completing the submission form in the partner dashboard, and understanding the review and launch process.

What You Will Do

• Prepare the necessary marketing, technical, and business information for your add-on
• Complete each section of the add-on submission form
• Understand what to expect during the internal review, beta launch, and general availability phases
• Learn about the criteria QuickNode uses to evaluate new add-ons

Prerequisites

Before you begin this guide, please ensure you have the following ready:

• An Approved Partner Account: This entire process takes place within the partner dashboard. If you have not yet been approved, please start with our Getting Started guide.
• A Fully Developed Add-on: You must have a complete, locally-tested add-on. If you have not finished the technical implementation, please follow our How to Build a Marketplace Add-on guide first.
• Your Complete Listing Materials: You should have your add-on's name, description, icon, screenshots, and finalized pricing plans prepared, as detailed in the Preparing Your Marketplace Listing guide.

Step 1: Completing the Submission Form

With your details prepared, you can now complete the submission process. Log in to your QuickNode dashboard and navigate to the Partners section by clicking on your profile icon in the top-right corner and selecting Switch to Partners.

Basic Information

This section covers the core details of your add-on.

• Add-on Name and Descriptions: Provide a clear, descriptive name, a short description, and a detailed description for your add-on.
• Icon and Screenshots: Upload the visual assets you prepared.
• Support Email and URL: Provide contact information for users seeking support.
• Alert Email: Enter an email address where QuickNode can send automated alerts regarding your add-on's status and health.
• Supported Chains and Networks: Select all the chains and networks your add-on supports (e.g., Ethereum Mainnet, Polygon PoS).

Technical Configuration

Here, you will define how your add-on integrates with the QuickNode platform.

• Authentication Method: Choose the method that matches your implementation:

  • Provisioning APIs
  • HTTP Basic Auth
  • Custom HTTP Header
  • No Authentication

• JWT Secret (if applicable): If your add-on has its own dashboard and QuickNode users need to access it, you must provide a secure secret key for signing JSON Web Tokens. You can generate one using the command: openssl rand -hex 32.

• Using Customers' QuickNode API Endpoints: Select "Yes" if your add-on needs to make calls to the user's underlying QuickNode endpoint. Selecting "Yes" ensures those calls are properly attributed to the user's endpoint.

Add-on Type Details

Next, you will provide the specific configuration details for your chosen add-on type.

RPC

For each custom JSON-RPC method, you must define its structure and behavior:

• Method Name: The name of your custom method (e.g., qn_fetchTokenBalance).
• Parameter Structure: How the parameters will be structured.
  • By Position (Array): Parameters are passed in order (e.g., ["param1", "param2"]).
  • By Name (Object): Parameters are passed as named objects (e.g., {"param1": "value1", "param2": "value2"}).
• Number of Parameters: Specify the number of parameters that the method requires. (Valid only if the parameter structure is by position)
• Upstream Service URL: The full URL where your RPC service is hosted (e.g., https://www.yourservice.com/rpc).
• Health Check URL: The URL for monitoring your service's availability (e.g., https://www.yourservice.com/healthcheck).
• Documentation URL: A link to your public API documentation (e.g., https://yourservice.com/docs/api).
• Description: A clear explanation of what the method does.

After entering all the details for one method, click Add. Repeat this process until all your methods are listed and configured.

After adding your RPC methods, you should update each method to include detailed parameter information such as the parameter name, data type, and sample value. Note that when entering a sample value, provide only the raw value. For example, if the data type is string, do not put quotation marks (") around the sample value.

REST

For each REST path your add-on exposes, you will need to provide the following:

• HTTP Method: The method for the path (e.g., GET, POST).
• REST API URL: The full upstream URL for the specific path (e.g., https://api.yourservice.com/v1/prices). If your URL has placeholders, use curly braces (e.g., https://api.yourservice.com/v1/prices/{currency}).
• Health Check URL: The URL for monitoring the availability of your service.
• Documentation URL: A link to your public API documentation.
• Description: A clear explanation of what the endpoint does.
• Sample URL: A full, executable URL with real example values for users to test (e.g., https://api.yourservice.com/v1/prices/ETH).
• Sample Query String: If the endpoint accepts query parameters, provide an example (e.g., currency=EUR&exchange=coinbase).

After entering all the details for one REST path, click Add. Repeat this process until all your paths are listed and configured.

External

For an External add-on, you must provide clear instructions for your users. Feel free to use Markdown formatting to enhance readability.

• Getting Started Instructions: Write a clear, step-by-step guide that will be displayed to users immediately after they enable your add-on. This should explain how they can access their dashboard via SSO and where to find their API key or other necessary setup information.

Features

In this section, list the key features of your add-on. Use this to highlight what makes your service valuable and unique to potential users. This information is used on the Marketplace listing page and helps users compare plans.

Each feature you mention here will tie directly into the plans you set up later.

Plans

Finally, define the subscription tiers you will offer. For each plan (e.g., Starter, Pro), you will set a monthly price and associate the specific features available to users on that tier. This allows you to create flexible pricing that scales with user needs.

If your add-on is either RPC or REST, you should define the following additional fields:

• Request Per Second (RPS) Limit
• Monthly Request Limit

Note: QuickNode will enforce the add-on plan's Request Per Seconds Limit (RPS Limit) and Monthly Requests Limit for customers, if you have set them up. You don't need to implement this in your add-on.

Test Access

Before you submit your add-on, the final step is to request test access from the QuickNode team. This step verifies that your add-on runs smoothly within QuickNode’s infrastructure prior to launch.

Carefully review the form, and once everything looks accurate, click Submit Request. If you notice any issues, make the necessary updates before submitting.

Update Authentication Details (if applicable)

For add-ons that use Provisioning APIs, QuickNode will issue dedicated credentials after you submit your add-on request. These credentials replace any temporary username and password you used during development. You must update your server's environmental variables to use the provided credentials, which will be provided in the Security tab of your QuickNode dashboard.

These credentials are unique to your add-on and must be kept secure. They are required for all authenticated provisioning, update, and deprovisioning requests.

Step 2: The Review and Testing Process

After you complete and submit the form, your add-on enters our review and testing pipeline. This process involves a review by our team, followed by an integrated testing phase for you to validate your add-on's behavior within the QuickNode environment.

QuickNode's Internal Review

The first stage is a technical review by the QuickNode team. We will check your configuration, test your endpoints, and ensure your service is stable, secure, and provides a good user experience. We will communicate with you directly if any issues are found or if we have questions about your implementation.

Integrated Testing

Once your add-on passes our internal review, you will be granted access to test it within the QuickNode infrastructure. This allows you to validate the complete user lifecycle and ensure your integration is working correctly before it is made public. You can simulate user actions and test functionality such as:

• Provisioning, updating, deprovisioning, and deactivating (PUDD) events
• Direct add-on calls through a live QuickNode endpoint
• The complete Single Sign-On (SSO) integration flow

Note

This integrated testing environment is currently only available for add-ons that use the Provisioning APIs authentication method.

Step 3: Beta Launch

After you have thoroughly tested your add-on in the integrated environment and are confident in its stability and performance, the next step is to apply for Beta Access. This will make your add-on publicly available on the Marketplace with a Beta tag, allowing you to gather feedback from early adopters.

During the beta phase, you should aim to have at least 10 active users test your add-on to ensure you receive sufficient and meaningful feedback before a full launch.

Step 4: General Availability

After a successful beta period where you have addressed user feedback, you can apply to move to General Availability. This removes the Beta tag and lists your add-on as a fully supported, production-ready solution.

Conclusion

Congratulations! Your add-on is now live on the QuickNode Marketplace and available to developers worldwide. This marks the beginning of our partnership, and we are invested in your success.

Continue to engage with your users, gather feedback, and market your add-on to the community. For promotional strategies and best practices, you can always refer back to the Preparing Your Marketplace Listing guide.

We ❤️ Feedback!

Let us know if you have any feedback or requests for new topics. We'd love to hear from you.