How to Document Integrations on Make.com

Effective integration documentation on make.com helps users understand what your app does, when to use specific modules, and how to configure them correctly. This how-to guide explains the required structure, content standards, and writing tips you should follow when preparing partner integration documentation.

Why Clear Documentation Matters on Make.com

Good integration documentation on make.com has two main goals:

• Set expectations about what the integration and its modules can do.
• Guide users through configuration and real-world usage with minimal friction.

When your content is clear and consistent, users can quickly answer three key questions:

1. What does this integration do?
2. When should I use a specific module?
3. How do I set it up correctly?

Core Principles for Make.com Integration Docs

The official documentation standards used by the make.com team follow several core principles. Apply these to every partner integration page you create.

Focus on User Intent

Every section of your documentation should map to a user need. Avoid documenting internal implementation details that do not help a user build or troubleshoot a scenario.

• Describe capabilities and typical use cases.
• Explain parameters in plain language.
• Highlight limitations or important behaviors.

Use Consistent Structure Across Make.com Integrations

Consistency across make.com integrations makes it easier for users to move from one app to another. Reuse the same order of sections, naming conventions, and level of detail for each module.

Standard Page Structure for Make.com Integrations

Each integration page on make.com should follow a predictable structure so users can scan quickly and find what they need.

1. Integration Overview

Begin with a concise overview that answers:

• What the app is and what problems it solves.
• What the integration on make.com enables (e.g., syncing data, automating tasks).
• Any high-level limitations or requirements.

Keep this section short and user-focused. Avoid marketing copy and instead emphasize practical outcomes.

2. Authentication and Connection

Describe how users connect their account to your integration:

• What authentication method is used (API key, OAuth, token, etc.).
• Steps to obtain credentials in the third-party app.
• Steps to add or authorize the connection inside make.com.

Call out any permissions, scopes, or security considerations that might affect data access.

3. Available Modules on Make.com

List and describe every module that your integration offers on make.com. Group modules logically, such as:

• Triggers
• Actions
• Searches or data retrieval modules

For each module, provide a short description that explains the main purpose and when a user should choose it over other modules.

4. Module Reference Sections

Create a dedicated subsection for each module available on make.com. Each module section should include:

• Module name that matches the UI label.
• What it does in one or two clear sentences.
• When to use it with simple examples.
• Field descriptions explaining every important parameter.
• Output details for data returned by the module, if applicable.

This structure allows users to treat each module section as a quick reference while building scenarios in make.com.

Naming and Style Guidelines for Make.com Docs

Use consistent style and naming so that your documentation looks and reads like native content on make.com.

Module and Field Naming

• Match module and field names to what users see in the make.com interface.
• Avoid abbreviations unless they are widely recognized by your user base.
• Use title case for module names and sentence case for descriptions.

Writing Style and Tone

• Write in clear, simple English.
• Prefer short sentences and short paragraphs.
• Use active voice and direct instructions (e.g., “Select the account” instead of “The account should be selected”).
• Avoid internal jargon and engineering terms whenever possible.

How to Describe Modules on Make.com Step by Step

When documenting a module for make.com, follow this sequence to keep sections consistent and user-friendly.

Step 1: Introduce the Module

Start with one or two sentences:

• Explain what the module does.
• Describe the typical scenario where it is helpful.

Example structure: “Use this module to <action> when <condition or context>.”

Step 2: Explain Input Fields

List important fields in a clear, structured way. For each field, include:

• Field name (match make.com UI).
• Type or format if important (text, email, URL, number, list, etc.).
• Description in plain language.
• Whether it is required or optional.

When options are complex, use bullet points or short tables to keep them easy to scan.

Step 3: Describe Outputs

If the module returns data, document:

• Which items or bundles will be output.
• What each key output field represents.
• Any known limits or truncation rules.

This is especially important for search and list modules on make.com that can return many items.

Step 4: Add Usage Notes and Best Practices

Call out details that may affect how users design scenarios, such as:

• Rate limits or recommended pagination settings.
• Filtering tips to reduce excess data.
• Common pitfalls that cause errors.

Creating Scenario-Based Examples for Make.com

Scenario-based examples help users understand how modules work together in real automations on make.com.

Choose Realistic Use Cases

• Select common tasks your users perform in the app.
• Show how an event in one service triggers an action in another.
• Keep each example focused on a single outcome.

Outline the Scenario Flow

Describe the scenario in simple steps, such as:

1. Trigger module that starts the scenario.
2. Any filters or routers used.
3. Core action modules that perform updates or create items.
4. Final steps such as notifications or logging.

Where useful, reference the specific module names exactly as shown in make.com.

Maintaining and Updating Make.com Integration Docs

Integration documentation should evolve with each release of your connector on make.com.

Track Changes to Modules

• Update descriptions when fields are added or removed.
• Revise examples if recommended patterns change.
• Document new triggers, actions, or searches as they are introduced.

Review for Accuracy and Clarity

On a regular basis:

• Retest examples to confirm they still work as described.
• Remove outdated screenshots or references.
• Verify that terminology matches the latest UI in make.com and in the third-party app.

Additional Resources for Make.com Documentation

To follow the official standards in more detail, review the original how-to guide and related resources.

• Official Make.com integration documentation guide
• ConsultEvo automation and integration resources

By applying these structures and practices, your integration pages on make.com will be easier to read, simpler to maintain, and more effective at helping users build successful scenarios.