Custom Connector
Use the Custom connector to connect any REST API and make it available to your agent.
When to use it
The Custom connector is useful when:
- A system is not available as a built-in connector.
- You need a small number of specific API calls.
- You want full control over inputs, outputs, and error handling.
Set up the connector
- Open Connectors and click New.
- Choose Custom.
- Enter the base URL for your API.
Define actions
Actions describe the API calls the agent is allowed to make. For each action, you specify:
- The endpoint path and HTTP method.
- Input fields the agent can fill in.
- Output fields the agent can read.
Inputs can be used in headers, query params, or the request body. Outputs can be mapped to variables for later steps in a Flow.
Manage secrets
Add secrets (API keys or tokens) in the connector settings. Secrets are stored securely and are not shown after saving. You can reference them in your action definitions.
If you rotate a secret, update it here and it will apply to new runs.
Test and use in Flows
Use the test runner on the connector page to validate inputs and outputs. When the action works as expected, add the Custom connector to your Flows the same way you use any other connector.
Use test inputs first to confirm the response format before wiring the action into production workflows.