How it works
1
The assistant checks what it can create
It calls
list_connection_types to see which connection types support links and which non-secret fields it may fill in for you (name, host, port, database, user name, and so on).2
The assistant creates a link
It calls
create_connection_link with the connection type, the fields it knows, and an optional note about what the connection is for. It gets back a link to share with you.3
You open the link and sign in
The link opens the dashboard. Sign in as the same Integrate.io user the assistant is connected as, and finish signing in in the same browser tab.
4
You confirm where the credential goes
If the assistant filled in a host, the page shows what it requested first. Choose This is my server, continue to keep it, or Continue without the host to type your own. The note from the assistant is shown as unverified text.
5
You fill in the connection and click Create Connection
The page opens the same New connection panel as Connections → New Connection, with the assistant’s fields already filled in. Choose the Access type (direct, SSH tunnel or reverse SSH tunnel), enter the password or key, optionally test the connection, and click Create Connection.
6
The assistant picks up the new connection
The assistant calls
get_connection_link_status until the status is completed, then uses the returned connection ID.The password or key you type goes straight from the dashboard to Integrate.io, the same as creating a connection by hand. It never appears in a tool argument, a tool result, the link URL, or the assistant’s conversation.
Supported connection types
list_connection_types returns the current list for your account, along with notes to pass on to you (for example, allowlisting Integrate.io’s IP addresses on your firewall). OAuth connections such as Salesforce or HubSpot can’t be created through a link yet.
Link lifetime
Tunnels and key authentication
If you choose SSH tunnel or Reverse SSH tunnel, or key authentication for SFTP, the dashboard opens the new connection’s edit page after you click Create, the same as in the normal flow, so you can copy the public key or tunnel details. A notification confirms whether the assistant was told about the connection. The connection only works once you have installed the public key on your server or started the tunnel. Tell the assistant when that is done.Tool reference
list_connection_types
Read-only. Lists the connection types that can be created through a link, with the fields the assistant may fill in and notes for the user.Return a single entry, for example
postgres. An unsupported type returns an error listing the supported ones.create_connection_link
Write. Creates a one-time connection link for the signed-in user. Requires permission to create connections in the account. Supportsdry_run (validates without creating a link) and idempotency_key (a retry with the same key returns the original link, even after it has lapsed; use a new key for a new link).
Only that type’s
prefill_fields. Any other key, a password or key, or a connection string (scheme://user:password@host) is rejected with an error naming the offending fields. host must be a bare hostname or IP address.Up to 200 characters, shown to the user on the page as an unverified note. Must not contain a connection string.
get_connection_link_status
Read-only. Reports the outcome of a link.pending (the user has not finished yet, including up to 30 minutes past expires_at once the page has been opened), completed, or expired (the link lapsed or never existed; create a new one).The new connection’s ID, once
completed. connection_name, type, expires_at, and completed_at are also returned.