API Builder Client
Overview
The ApiBuilderClient is a workflow editor component that renders the interface for custom API integration nodes inside the Workflow Editor. When you drag a custom API integration onto the workflow canvas, the ApiBuilderClient provides the configuration panel where you select credentials, choose an endpoint, and set parameters.
Purpose
The ApiBuilderClient bridges the gap between integration definitions (created in the API Builder wizard) and workflow execution. It translates your saved API configuration into an interactive node editor that workflow authors can use without needing to understand the underlying API details.
How It Works
When a custom API integration node is selected on the workflow canvas, the ApiBuilderClient:
- Loads the integration definition — Fetches the saved API configuration (base URL, auth type, endpoints) from the registry endpoint
- Displays available endpoints — Shows the endpoints you defined in the wizard as selectable options
- Renders parameter inputs — For the selected endpoint, displays input fields for each parameter (query, path, header, body) based on the endpoint definition
- Handles credential selection — Lets the user choose which saved credential to use for authentication
- Maps outputs — Displays the output fields defined in the response configuration, so downstream nodes can reference them
Configuration
| Setting | Description |
|---|---|
| workflowId | The unique identifier for the workflow context. Links the component to the correct workflow state. |
| store | The state management object that handles the API builder's data persistence. |
| registryEndpoint | The URL endpoint where the component fetches available API endpoint definitions and configurations (default: /api/api-builder/nodes). |
| apiBasePath | The base URL for all API interactions initiated through the component (default: /api/api-builder). |
| title | The display title shown at the top of the interface (default: API Call Designer). |
| description | Contextual description shown beneath the title (default: Drag and drop API endpoints to create custom call logic.). |
In the Workflow Editor
After an integration is created via the API Builder wizard and credentials are added:
- The integration appears in the Node Library under the App or Custom category
- Drag it onto the canvas to create a node
- The Properties Panel shows the ApiBuilderClient interface:
- Credential selector — Choose which saved credential to authenticate with
- Endpoint selector — Pick which API operation to call
- Parameter inputs — Fill in required and optional parameters
- The node's outputs correspond to the fields defined in the endpoint's response configuration
Related Documentation
- API Builder Overview — Full guide to creating custom integrations
- Wizard Walkthrough — Step-by-step wizard guide
- API Builder Page — The page that hosts the wizard interface