Health check - Conductor Docs

QuickBooks Desktop API

Core Resources

Auth Sessions
End Users

Utilities

GET
Health check

General

Accounts
Classes
Customers
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
Sales Representatives
Sales-Tax Codes
Standard Terms
Vendors

Transactions

Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Credit Card Charges
Credit Card Credits
Credit Memos
Estimates
Inventory Adjustments
Invoices
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Time Tracking Activities
Transfers
Vendor Credits

Items

Discount Items
Inventory Assembly Items
Inventory Items
Non-Inventory Items
Sales-Tax Items
Service Items
Subtotal Items

GET

quickbooks-desktop

health-check

import Conductor from 'conductor-node';

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

async function main() {
  const response = await client.qbd.healthCheck({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(response.duration);
}

main();

{
  "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}}").

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.

status

string

required

The status of the health check.

Allowed value: "ok"

Delete an end-user The Account object

import Conductor from 'conductor-node';

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

async function main() {
  const response = await client.qbd.healthCheck({ conductorEndUserId: 'end_usr_1234567abcdefg' });

  console.log(response.duration);
}

main();

{
  "duration": 100,
  "status": "ok"
}