Good documentation makes your Bubble plugin usable and trustworthy in the marketplace. This tutorial shows how to write clear parameter descriptions, usage examples, and setup instructions in the Plugin Editor so other Bubble builders can install and use your plugin without guessing how it works.
Overview: Documenting API Calls in Bubble's Plugin Editor
A well-documented plugin gets more installs, fewer support requests, and better reviews. This tutorial covers writing parameter descriptions, documenting expected formats, creating usage examples, and structuring your plugin's marketplace page so builders can use your plugin immediately.
Prerequisites
- A Bubble account with a plugin in development
- Access to the Plugin Editor at bubble.io/home/plugins
- Understanding of how API calls work in the Plugin Editor
- At least one API call configured in your plugin
Step-by-step guide
Write clear parameter descriptions
Write clear parameter descriptions
In the Plugin Editor, click on your API call. For each parameter, fill in the Description field with: what the parameter does, the expected format, whether it is required or optional, and an example value. For example: 'API Key — Required. Your service API key from the dashboard. Example: sk_live_abc123'. Use consistent formatting across all parameters.
Expected result: Every parameter has a clear description with format, requirement, and example.
Document expected inputs and outputs
Document expected inputs and outputs
In the plugin's General tab, add a comprehensive description. List each action your plugin provides with: Action name, What it does, Required parameters, Optional parameters, Return values and their types. Format this as a structured reference that builders can scan quickly. Use markdown-style formatting for readability (Bubble supports basic formatting in plugin descriptions).
Expected result: The plugin description includes a structured reference of all actions with inputs and outputs.
Add setup instructions
Add setup instructions
In the plugin settings section, add fields for configuration values (API keys, base URLs). For each setting, add a description explaining where to find the value. In the General description, add a Setup section with numbered steps: 1) Install the plugin, 2) Go to Settings → your plugin, 3) Enter your API key from [service dashboard URL], 4) Test with the sample action. Include links to the external service's documentation where relevant.
Pro tip: Add a troubleshooting section covering common setup issues like invalid API keys, wrong base URLs, and permission errors.
Expected result: Builders can install and configure your plugin by following the setup instructions without external help.
Create usage examples for each action
Create usage examples for each action
For each action, document a real-world usage example. Include: the workflow trigger (e.g., When button is clicked), the action configuration with parameter values, and the expected result. Use Bubble-specific language: 'Set the email parameter to Input Email's value' rather than generic API documentation language. If your plugin returns data, explain how to access it using Result of step X. For complex plugins with multiple actions, RapidDev can help write comprehensive documentation and tutorials.
Expected result: Each action has a practical usage example that builders can follow step by step.
Structure your marketplace listing
Structure your marketplace listing
Your plugin's marketplace page is the first impression. Structure it with: (1) A one-sentence summary of what the plugin does. (2) Key features as a bullet list. (3) Quick setup steps (3-5 steps). (4) Action reference table. (5) FAQ section for common questions. (6) Support contact or forum link. Add screenshots of the plugin in use if possible. Keep the language simple and beginner-friendly.
Expected result: A well-structured marketplace listing that communicates your plugin's value and setup clearly.
Complete working example
1PLUGIN DOCUMENTATION — TEMPLATE2================================34MARKETPLACE DESCRIPTION:5 [Plugin Name] — One sentence summary67 FEATURES:8 - Feature 19 - Feature 210 - Feature 31112 SETUP:13 1. Install the plugin14 2. Go to Plugins tab → [Plugin Name]15 3. Enter your API key from [service URL]16 4. Test with the [sample action]1718 ACTIONS:19 [Action Name]20 Description: What it does21 Parameters:22 - param1 (required): Description. Example: value23 - param2 (optional): Description. Default: value24 Returns: description of return values25 Usage: When [trigger] → [Action] with param1 = [source]2627 FAQ:28 Q: How do I get an API key?29 A: Sign up at [service URL] and go to Settings → API keys.3031 Q: What happens if [common error]?32 A: [Troubleshooting step]3334 SUPPORT:35 Forum: [URL]36 Email: [address]Common mistakes when documenting API calls in the Plugin Editor for Bubble.io: Step-by-Step Guide
Why it's a problem: Leaving parameter descriptions blank
How to avoid: Fill in every parameter description with format, requirement, and example value.
Why it's a problem: Using technical API jargon instead of Bubble terminology
How to avoid: Use Bubble-specific language: workflows, actions, data sources, steps, instead of API terminology.
Why it's a problem: Not including troubleshooting information
How to avoid: Add a troubleshooting section covering the 3-5 most common issues and their solutions.
Best practices
- Fill in descriptions for every parameter with format, requirement, and example
- Use Bubble-specific terminology that non-technical builders understand
- Include numbered setup steps with links to external service dashboards
- Document expected return values so builders know how to use results
- Add a troubleshooting section for common issues
- Keep documentation updated when you release new versions
- Include at least one real-world usage example per action
Still stuck?
Copy one of these prompts to get a personalized, step-by-step explanation.
I built a Bubble plugin with three actions. Help me write clear documentation for each action including parameter descriptions, usage examples, and a troubleshooting section.
Help me write the description for my plugin's marketplace listing. The plugin connects to [service] and provides actions for [list actions]. I need a clear structure with setup steps and usage examples.
Frequently asked questions
Where do parameter descriptions appear?
In the Bubble editor, when a builder configures your plugin's action in a workflow, each parameter shows its description as helper text below the input field.
Can I add images to my plugin description?
The marketplace description supports basic formatting and image URLs. Upload screenshots to an image hosting service and reference the URLs.
How do I update documentation for a new version?
Edit the descriptions in the Plugin Editor and publish a new version. Update the General description with a changelog noting what changed.
Should I document internal-only API calls?
Only document calls that plugin users will interact with. Internal helper calls do not need user-facing documentation.
How do I handle different API versions in documentation?
Note the external API version your plugin supports. If you release a new plugin version for a new API version, document the migration steps.
Can RapidDev help with plugin development and documentation?
Yes. RapidDev can develop custom Bubble plugins with comprehensive documentation, marketplace optimization, and ongoing maintenance support.
Talk to an Expert
Our team has built 600+ apps. Get personalized help with your project.
Book a free consultation