Skip to main content

Using Credentials with Tools

A credential on its own is like a spare key sitting in a drawer — useful only once you put it in a lock. You unlock it by connecting it to a tool in your agent's setup. This page explains how credentials and tools work together, and how to link them. A credential is the saved sign-in details Nirvai uses to act on your behalf with another service, and a tool is an action your agent can take, like sending an email.


How it works

When your agent decides to use a tool (for example, "send an email"), the tool automatically loads the credential you've linked to it. The credential carries the sign-in details, so the tool can reach the other service on your behalf. Your agent never sees the raw sign-in details — it just gets the result back.


Connecting a credential to a tool

  1. Open your agent in the Agent Control Panel.
  2. Go to the Tools step.
  3. Add a tool or select an existing one.
  4. In the tool's settings, find the Credential dropdown.
  5. Choose the credential you want to use.
  6. Save the agent.

Selecting a credential in the tool configuration dropdownImage: Selecting a credential in the tool configuration dropdown

The dropdown only shows credentials that fit the tool. For example, a Gmail tool only shows credentials that sign in with a Google account.

tip

If the dropdown is empty, you need to create a credential for that service first.


One credential, many tools

A single credential can power several tools across different agents. For example, one Google sign-in credential can be used by:

  • A Gmail tool in your customer support agent
  • A Google Sheets tool in your data entry agent
  • A Google Calendar tool in your scheduling agent

If you update or re-connect the credential, every tool that uses it updates automatically.


One credential, many agents

The same credential can be shared across agents too. If three agents all need to send emails through Gmail, they can all point to the same Gmail credential — you don't need to create one per agent.


Tools that need a credential

Most tools that reach an outside service need a credential. Here are some common examples:

ToolWhat it connects withWhat it does
Send Email (Gmail)A Google sign-inSends emails from your Gmail account
Post Message (Slack)A Slack sign-inPosts messages to Slack channels
Create Contact (HubSpot)A HubSpot sign-inAdds contacts to your CRM
Send WhatsApp MessageA Meta (WhatsApp) connectionSends WhatsApp messages from your business number
Get Orders (Shopify)A Shopify sign-inLooks up order data from your store
Generate Text (OpenAI)An OpenAI private codeAsks OpenAI's models to write text

Custom tools

When you build a custom tool (a tool that reaches your own service or another one not listed), you choose what kind of connection it needs during setup. The tool settings will ask you to:

  1. Pick the connection type (a private code, an access pass, a "Log in with…" sign-in, a username and password, or a Meta connection).
  2. Link a saved credential of that type.
  3. The tool will use that credential's details whenever it runs.

For Meta-type custom tools, choosing a credential fills in the connection details automatically — you don't need to enter them by hand.

info

Custom tools that reach a public service with no sign-in don't need a credential at all. Set the connection type to None during setup.


When a credential stops working

Credential typeWhy it might stopWhat to do
Private code (API key)The service expired or revoked itTool calls fail. Get a new code and update the credential
Access pass (token)The service expired itTool calls fail. Get a new pass and update the credential
"Log in with…" sign-inAccess renews on its own, but sometimes lapsesIf it lapses, re-connect from the Managing page
Username and passwordYou changed your passwordUpdate the credential with the new password
MetaConnections don't usually expireIf something breaks, re-connect through Facebook sign-in
warning

When a credential stops working or is deleted, every tool using it stops working too. Check which tools depend on a credential before you change it. See Managing Credentials for details.


Troubleshooting

ProblemFix
The credential dropdown is emptyCreate a credential for that service first — the dropdown only shows credentials that match the tool
My credential isn't in the dropdownIt may be the wrong type for this tool. The dropdown only lists credentials that fit, so create or pick the right one
The tool fails after working fine beforeThe credential may have stopped working. Open Managing Credentials, then update or re-connect it
My custom tool won't save without a credentialEither link a credential, or set the connection type to None if the service needs no sign-in

What's next

After linking your credentials, continue to Managing Credentials to keep them up to date.