POST
/
connection
/
{id}
/
check
JavaScript
import Openint from '@openint/sdk';

const client = new Openint({
  token: 'My Token',
});

const response = await client.checkConnection('conn_');

console.log(response.id);
{
  "id": "<string>",
  "status": "healthy",
  "status_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Organization API Key available in the settings page of the OpenInt Console or Customer API Key or Token Customer authentication token created using the create customer token API. It is passed in the authorization header with format: Bearer {token}

Path Parameters

​
id
string
required

The id of the connection, starts with conn_

Response

Successful response

​
id
string
required
​
status
enum<string> | null
Available options:
healthy,
disconnected,
error,
manual,
unknown
​
status_message
string | null