Test Connection

Step 4: Configure Test Connection

The Test Connection tab allows System Builders or users to verify connectivity with a system by entering a sample API endpoint. This is a useful tool to ensure the configured credentials are valid and that the system is reachable.

As a best practice, it is recommended to use a simple GET API without URL arguments or version numbers as the Test Connection API to ensure consistency and reliability in testing. The user has the flexibility to freely navigate between tabs without needing to save their progress. If credential fields are typed in (but not yet saved), the “Use Direct Values” option in the Test Connection tab will still reflect these unsaved values on the front end, allowing users to test with live inputs.

To use the value of any credential input in the API endpoint or request, the syntax {{inputs.keyname}} should be used. For example, to insert a user-entered API key with the key name api_key, use {{inputs.api_key}} within your request or headers. The base URL for the Test Connection API and all related API endpoints will always begin with {{inputs.host_name}}/, which is non-editable and must be assumed as a required prefix to all test URLs.

The system supports two ways of testing:

1. Using Stored Credentials – credentials that have already been saved to the system.

2. Using Direct Values – credentials that are typed in temporarily for testing purposes, without needing to be saved first.

However, for OAuth2 and Token Authentication methods, only stored credentials can be used for testing. In these cases, the “Use Direct Values” option will not be available, as these authentication types depend on stored tokens and authorization flows that cannot be simulated with direct inputs.