Skip to main content
GET
/
quickbooks-desktop
/
health-check
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

const response = await conductor.qbd.healthCheck({ conductorEndUserId: 'end_usr_1234567abcdefg' });

console.log(response.duration);
{
  "duration": 100,
  "status": "ok"
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Response

200 - application/json

Returns an object with the duration of the health check in milliseconds. If the health check fails, returns the standard Conductor error response. For end-user UI, prefer error.userFacingMessage; use error.message for logs, developer/admin surfaces, and test projects.

​
duration
number
required

The time, in milliseconds, that it took to perform the health check.

Example:

100

​
status
string
required

The status of the health check.

Allowed value: "ok"
Example:

"ok"