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

1. Open Connectors and click New.
2. Choose Custom.
3. 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.

Use secrets

Create named secrets in Settings > Workspace > Secrets before adding credentialed actions. A secret can contain multiple key/value pairs, such as API_KEY, ACCESS_TOKEN, and ACCOUNT_ID.

Select the named secret on each Custom connector action that needs credentials.

HTTP actions can reference keys with {secrets.KEY_NAME} in the URL, headers, or body:

{
  "Authorization": "Bearer {secrets.API_KEY}",
  "X-Account-ID": "{secrets.ACCOUNT_ID}"
}

Code actions receive the selected secret’s keys as environment variables, so a key named API_KEY is available as API_KEY inside the action runtime.

If you rotate a credential, update the secret from the Secrets page and keep the same key names so existing actions continue to work.

For more detail, see Secrets.

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.