Your account does not have the Voice Agent admin role required to configure Corelation credentials. Ask a Voice Agent admin in your organization to enter the credentials or update your permissions.
Configure the Corelation integration
Your Corelation integration is configured for the selected environment, and you can verify the connection status.
Before you start
Who can do this: Voice Agent users. You must have a Voice Agent admin role to enter, edit, or test credentials.
Pro Mode: not required.
You'll need: Your Corelation KeyBridge Query Language XML endpoint, query username, query password, and query device name.
Depends on your setup: A Corelation KeyBridge environment with Aviary egress allowlisted if required by your credit union.
Steps
In the left sidebar, under Voice Agent, select Integrations, then open the Corelation integration. The Corelation Integration page opens.
Select the Test or Production tab for the environment you want to configure. The environment's Connection status and API credentials sections appear.
If credentials are already saved and you want to update them, select Edit Credentials under API credentials. The credential fields become editable.
Enter your KeyBridge endpoint in Corelation URL, then fill in Query Username, Query Password, and Query Device Name.
Optionally, fill in Query Timezone (optional), Institution ID (optional), Default Note Type Serial (optional), or Default Placement User Serial (optional).
If your organization uses Legacy Settings, enter Legacy KeyStone Base URL (optional) and Legacy API Key (optional).
Select Save Credentials. The "Credentials saved successfully" notification appears, and API credentials shows Credentials saved.
Under Connection status, select Test connection to verify the configuration. The button changes to Testing... while Aviary checks the connection.
To remove saved credentials for the selected environment, select Disconnect. The "Disconnected from Corelation" notification appears.
After you finish
Repeat these steps on the other environment tab if you need to configure both Test and Production.
Troubleshooting
You see "Corelation credentials have not been configured yet. Please contact an admin to set up the integration." and cannot enter credentials.
Saving fails with "Corelation URL, Query Username, and Query Device Name are required" or "Query Password is required on first save"
One or more required fields under API credentials are blank. Fill in Corelation URL, Query Username, Query Device Name, and, on initial setup, Query Password, then select Save Credentials again.
You see "Failed to save credentials" or "Failed to disconnect"
Aviary could not complete the request. Try the action again. If the problem continues, contact [email protected].