Test Connection

Verify your project key is valid before going live.

⏱ 2 minPrerequisites: Client created

Problem: You configured the SDK but are not sure if your project key is correct or if the API is reachable before you deploy.

Solution: Call testConnection() — it verifies your project key and returns the project name in under a second without creating any responses.

Usage

typescript
const result = await enterestos.testConnection();

if (result.ok) {
  console.log('Connected to:', result.projectName);
} else {
  console.error('Connection failed:', result.error);
}

Success Response

json
{ "ok": true, "projectName": "Demo Requests" }

Failure Response

json
{ "ok": false, "error": "Invalid project key" }

Result: You now have confirmation that your project key is valid and EnterestOS is reachable from your application.

Common Questions

Does testConnection() create a submission in my Inbox?

No. It is a read-only check. It only verifies that your project key is valid and the API is reachable. Nothing is written to your project.

When should I call testConnection()?

During setup and onboarding. Once you have confirmed your integration works with a real test submission, you do not need to call it again in production.

Next

Project Keys →