Skip to main content
For a vendor’s tool, request an integration and skip this page. When the vendor has a usable API, Neo’s team builds the whole API, typically within a few hours and sometimes up to 2 working days, with permission groups, technician approval for writes and a setup guide. You add only the key.
Custom API is available on a paid plan. During a trial, request an integration instead. Custom API connections are for your own in-house API or a webhook. You configure the endpoint and credential once on the Integrations page; any agent you allow can then call it by name through the External API Request tool. Each connection holds one web address and one method, so an API with several endpoints needs several connections.
Connections are how you give an agent an external API in the dashboard — the old per-agent configuration editor was retired after every existing setup was migrated to connections. Agents still running an inline API configuration set up through the API keep working during the deprecation window; new setups use connections. One definition and one credential, shared by every agent: rotating a key updates all of them at once.

Add a connection

Open Integrations, find Custom API under Other, and click Add API. The wizard walks through five steps:
1

Point Neo at the API

Name the connection, paste the web address, and pick what Neo does there — GET, POST, PUT, PATCH, or DELETE. A {placeholder} segment in the address (e.g. .../track/{trackingNumber}) becomes a value the agent fills in on every call.The address must start with https:// and be reachable from the internet, because Neo connects only to public addresses. A placeholder fills a path segment only, never the host name. If a firewall protects the API, allowlist Neo’s addresses.
2

Prove who Neo is

Pick how the API authenticates:Keys and secrets are stored in a secure vault, shown masked afterwards, and never appear in logs or event history.With API key in the web address, enter the parameter name from the docs (for Google Maps, key) and the key. Neo adds the key to every request, so it never goes in your agent instructions. Do not also define that name under Query parameters: the agent never fills it, and the stored key always wins.For OAuth 2.0 providers that need more than a client ID and secret, expand Advanced OAuth options: add custom token request parameters (when any are set, that list becomes the whole token request — include grant_type and everything else the provider’s docs list, marking passwords as secret) and, if the provider wants credentials in a header on the token request, token-endpoint Basic auth.
3

Teach Neo the blanks

Optional. Define Query parameters and, for requests with a body, Information Neo sends — each field gets a name, a type, a description, and whether it’s required. The agent reads the descriptions to fill fields correctly, so write what the value means, not just its name.Pick List when the API wants a JSON array — a recipients field that takes ["3546618111"] rather than "3546618111". Neo sends a List body field as an array, and a List query parameter as repeated ?name=value pairs.
4

Try it out

Send one real request before saving. The result is recorded on the connection, so you can see at a glance which connections have been verified.
5

Review & save

A plain-words summary of what you built. Save, and the connection appears under Connected APIs on the tile.

Test a saved connection

On the Custom API tile, every connection has a Test button (▶). It opens a dialog asking for any parameters the API needs, sends one real request with the stored credential, and records the outcome next to the connection. For a List field, separate the sample values with commas: the test sends 3546618111, 3546618112 as a two-item array. The result names the HTTP status the API answered with. Some APIs report an error inside a successful answer: Google Maps answers a bad or missing key with status 200 and "status": "REQUEST_DENIED". So read What the API sent back before you trust a green result. If an API redirects to another host, Neo follows the redirect without your key or custom headers, so the new host usually refuses the request. Enter the final address instead. Neo follows no redirect from an OAuth 2.0 token URL, because the request holds your client secret, so enter the address that issues the token.

Who can change a connection

An agent uses a connection the same way for everyone who can run it: running an agent never needs these rights. Each add, change and removal goes on that person’s activity history, with the address before and after and the name of any credential they replaced. It never shows a credential itself.

Use a connection from an agent

In the agent builder, enable the External API Request tool and pick the connection under Connected APIs. The agent calls it by its connection name, so use names your instructions can reference naturally — DHL_Tracking, slack_alert.

Use a connection from a dashboard

A dashboard can read a connection whose method is GET, such as a CSV export or a status feed. Ask the Neo Support Agent for the dashboard and name the connection; only an admin builds one. The dashboard calls the connection with GET only, with its stored credential, each time it refreshes. A POST, PUT, PATCH or DELETE connection cannot be a dashboard source.

Move a connection to another address

A stored credential goes only where it was saved to go, whatever your role. Neo asks for the credential again when you change any of these:
  • The host, scheme or port of the web address.
  • The host of the OAuth 2.0 token URL.
  • The authentication method, or the header name or parameter name that carries the key.
A new path or query on the same host keeps the credential. Extra headers cannot set Host, because that header can send a request to another site while the address looks the same. Until you save with the credential typed in, the connection and its agents stay on the saved address. When you save, every agent that uses the connection follows the change at once, so test the new address in the wizard first.

Update a credential

Edit the connection and type the new value over the masked one — a masked field left untouched keeps what’s stored. Every agent that references the connection uses the new credential immediately; nothing needs re-saving on the agents. For an OAuth 2.0 connection, Neo caches the access token and reuses it across runs. Saving the connection discards that token. If the API rejects a cached token with 401 Unauthorized, Neo gets a new token and sends the request once more. A second 401 goes back to the agent with its real status code, which usually means the API client lost access to that endpoint.