Check health status of all integrations

Use this request to check the health of the connected applications such as services for VAT validation, Shippo, Hurricane, Sendcloud and Dojo.

To test the status of connected services, use a GET operation and the folllowing URL:

{api_url}/Health/Integrations

where {api_url} is the URL of the API.

For example:
https://api.epalglobal.com//Health/Integrations

Details

Table 1. Request Details
Detail
Operation GET
Endpoint Health/Integrations
Fields Response Parameters only

Response Parameters

The request includes the following fields in the first level of the respoonse:

Table 2.
Response Parameter Detail Description
overallStatus
  • Type: String
 The overall status of all the connected services. The possible values are healthy, degraded, and unhealthy.
services
  • Type: Object
 The name of each service. You can expand to see the details for each service. Possible values are vat, shippo, hurricane, sendcloud, and dojo.
summary
  • Type: Object
 Summary of information about the overall status of the services. Possible values are totalServices, healthyServices, degradedServices, and unhealthyServices.
timestamp
  • Type: String
 The time and date when the check was run.

services Fields

The request returns the following fields for each connected service in the services object:
Table 3. Service Details Fields
Response Parameter Detail Description
name String The name of the service.
status String The status of the service. The possible values are healthy, degraded, and unhealthy.
apiAvailable Boolean True indicates that the service is available.
responseTime Number The time taken by the service to respond to the check.
testResult Object The result of the availability check.
errorDetails Object The details from the error message.

Example Response

The following is an example response to a successful request:
{
  "overallStatus": "healthy",
  "services": {
    "vat": {
      "overallStatus": "healthy",
      "primary": {
        "name": "string",
        "status": "healthy",
        "apiAvailable": true,
        "responseTime": 0,
        "testResult": {},
        "errorDetails": {}
      },
      "fallback": {
        "name": "string",
        "status": "healthy",
        "apiAvailable": true,
        "responseTime": 0,
        "testResult": {},
        "errorDetails": {}
      }
    },
    "shippo": {
      "name": "string",
      "status": "healthy",
      "apiAvailable": true,
      "responseTime": 0,
      "testResult": {},
      "errorDetails": {}
    },
    "hurricane": {
      "name": "string",
      "status": "healthy",
      "apiAvailable": true,
      "responseTime": 0,
      "testResult": {},
      "errorDetails": {}
    },
    "sendcloud": {
      "name": "string",
      "status": "healthy",
      "apiAvailable": true,
      "responseTime": 0,
      "testResult": {},
      "errorDetails": {}
    },
    "dojo": {
      "name": "string",
      "status": "healthy",
      "apiAvailable": true,
      "responseTime": 0,
      "testResult": {},
      "errorDetails": {}
    }
  },
  "timestamp": "string",
  "summary": {
    "totalServices": 0,
    "healthyServices": 0,
    "degradedServices": 0,
    "unhealthyServices": 0
  }
}