1
Open the create flow
Start from the integrations page and choose the action to add a new connection or template-based integration.
Integrations
Connect the systems the rest of the platform depends on.
Integrations bring operational and reporting data into the platform. This guide should walk users through setup, credential handling, and API-documentation-assisted import flows.
Before You Start
- Confirm you have the necessary credentials or tokens
- Know whether you are creating a new connection or editing an existing one
- Decide whether the connection should be reusable across workflows
What Integrations Are For
Users should think of integrations as the bridge between source systems and downstream dashboards, workflows, and reports.
Screenshot Placeholder
Recommended capture: Integrations landing page
Show the list of configured systems and any create or import actions.
Screenshot Placeholder
Recommended capture: Create integration dialog
Capture the first decision point where the user chooses type or template.
Create a New Integration
2
Choose the connection type
Depending on the system, you may start from a managed template, a custom integration, or an imported API definition.
3
Save and validate
After entering the required values, save the connection and confirm it is ready for downstream use.
Choose The Right Authentication Method
The UI supports multiple authentication patterns. User documentation should explain the choice in plain language rather than listing fields without context.
Document the purpose of each authentication type.
Explain when users should select basic auth, bearer token, OAuth, or another supported method in the platform.
Import From API Documentation
One of the differentiators in this product is the ability to parse API documentation and turn it into a starting integration definition.
- Users can provide a URL, upload a file, or select a cached documentation item.
- The platform parses supported specifications and surfaces endpoint choices.
- Users still need to review the generated configuration before using it in production workflows.
Manage Existing Integrations
A good guide should also cover ongoing maintenance: editing, rotating credentials, and verifying that connections still support reports and workflows as expected.