API Builder Page
Overview
The API Builder Page hosts the integration wizard — a step-by-step interface for creating and managing custom REST API integrations. This page is where you define how Vantage communicates with external APIs that don't have built-in integrations.
The wizard guides you through four steps: confirming technical readiness, entering general API information (name, base URL, authentication), defining endpoints with parameters and response mapping, and reviewing/saving the complete integration definition.
How It Works
The API Builder Page loads dynamically based on URL parameters:
| Parameter | Behavior |
|---|---|
| (none) | Opens the wizard in create mode — start a new integration from scratch |
edit=<integrationId> | Opens the wizard in edit mode — loads the existing integration's configuration for modification |
workflowId=<workflowId> | Opens the wizard linked to a specific workflow — loads the integration associated with that workflow |
When editing, the technical warning step is skipped since you've already acknowledged it during initial creation.
Navigation
- From Integrations page — Click "API Builder" or "Create Custom Integration" to start a new integration, or click the edit button on an existing custom integration.
- After saving — You're redirected to the Integrations page, where you can add credentials and start using the integration in workflows.
What Happens After Saving
After the wizard saves your integration definition:
- A unique service key is generated for the integration
- A credential schema is created matching your chosen auth type
- The integration appears on the Integrations page
- You must add credentials before the integration can be used in workflows
- Once credentials are configured, the integration appears as a draggable node in the Workflow Editor's Node Library
Related Documentation
For the complete guide on building integrations, see the API Builder documentation — it covers:
- REST API Fundamentals — Concepts behind every wizard field
- Wizard Walkthrough — Detailed step-by-step guide
- JSON Response Parser — Response mapping deep dive
- Examples — Complete real-world integrations
- Troubleshooting — Common issues and solutions