GET
/
quickbooks-desktop
/
health-check
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Response

200 - application/json

Returns an object with the duration of the health check in milliseconds. Returns an error if the health check fails, for which we strongly recommend displaying the property error.userFacingMessage to your end-user in your app.

​
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"