import Conductor from "conductor-node";
const conductor = new Conductor("{{YOUR_SECRET_KEY}}");

const pingResult = await conductor.endUsers.ping(
  "{{END_USER_ID}}",
  "quickbooks_desktop",
);
{
  "duration": "111"
}

This operation is useful for showing a “connection status” indicator in your app.

Parameters

id
string
required

The ID of the EndUser to ping.

integrationSlug
string
required

The integration identifier for the EndUser’s connection you want to ping (e.g. “quickbooks_desktop”).

Response

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

duration
integer

The time, in milliseconds, that it took to ping the connection.

import Conductor from "conductor-node";
const conductor = new Conductor("{{YOUR_SECRET_KEY}}");

const pingResult = await conductor.endUsers.ping(
  "{{END_USER_ID}}",
  "quickbooks_desktop",
);
{
  "duration": "111"
}