Ping Request

To make it easier to get started with integrations, you can use the ping request endpoint to send GET and POST request. If you receive a greeting message, you are good to go with your next steps.

Here are the available api requests and their responses

Ping

You can send a GET/POST request to the <BASE_URL>/ping endpoint. If the request succeeds, you will receive a response with 200 status code with a greeting message.

Response

{
greeting_message: "Hi <NAME>";
}

Here are some common implementation of the above request.

curl --location --request GET '<BASE_URL>/ping' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <TOKEN_HERE>'
var axios = require('axios');
var config = {
method: 'get',
url: '<BASE_URL>/ping',
headers: {
'Accept': 'application/json',
'Authorization': 'Bearer <TOKEN_HERE>'
}
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '<BASE_URL>/ping',
'headers': {
'Accept': 'application/json',
'Authorization': 'Bearer <TOKEN_HERE>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '<BASE_URL>/ping',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_TIMEOUT => 0,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Bearer <TOKEN_HERE>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Share