EndUsers
Ping an EndUser's connection
Checks whether the specified IntegrationConnection can connect and process requests end-to-end.
This operation is useful for showing a “connection status” indicator in your app.
Parameters
id
string
requiredThe ID of the EndUser to ping.
integrationSlug
string
requiredThe 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.