GET
/
end-users
/
{id}
/
ping
/
{integrationSlug}
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.endUsers.ping('end_user_1234567abcdefg', 'quickbooks_desktop');

  console.log(response.duration);
}

main();
{
  "duration": 100
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the end-user to ping.

integrationSlug
enum<string>
required

The integration identifier for the end-user's connection to ping.

Available options:
quickbooks_desktop

Response

200 - application/json
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`](/usage/error-handling#user-facing-error-messages) to your end-user in your app's UI.
duration
number
required

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