Check an end-user's connection status

Sometimes, it is useful to check whether an end-user’s connection is working. For example, you might want to display a “connection status” indicator in your app’s UI. To do this, you can use the health check endpoint to check whether the specified connection can connect and process requests end-to-end. If an error occurs, we recommend displaying error.userFacingMessage to your end-user because it is the user-friendly message for end-user UI. Use the primary error.message for logs, developer/admin surfaces, and test projects.

import Conductor from "conductor-node";

const conductor = new Conductor({ apiKey: "YOUR_SECRET_KEY" });

async function main() {
  try {
    await conductor.qbd.healthCheck({
      conductorEndUserId: "end_usr_1234567abcdefg",
    });
  } catch (error) {
    // Prefer `error.userFacingMessage` in end-user UI. Use `error.message` for
    // logs, developer/admin surfaces, and test projects.
  }
}

main();

from conductor import Conductor

conductor = Conductor(api_key="YOUR_SECRET_KEY")
try:
  response = conductor.qbd.health_check(conductor_end_user_id="end_usr_1234567abcdefg")
except Exception as e:
  # Prefer `e.user_facing_message` in end-user UI. Use `str(e)` for logs,
  # developer/admin surfaces, and test projects.
  pass

curl --request GET \
  --url https://api.conductor.is/v1/quickbooks-desktop/health-check \
  --header 'Authorization: Bearer {{YOUR_SECRET_KEY}}' \
  --header 'Conductor-End-User-Id: {{YOUR_END_USER_ID}}'

Getting Started

Usage

QuickBooks Desktop

Check an end-user's connection status