Health Check API Response

Implementing the health check from Partner Ecosystem Management involves adding a health check endpoint in Partner Ecosystem Management. This page describes the structure of the API response Partner Ecosystem Management expects from the Merchant after Partner Ecosystem Management calls the health check endpoint. The Merchant is expected to return the status for each service. Partner Ecosystem Management polls the Health Check API (GET /v1/health) in pre-defined intervals. The health check allows the Partner Ecosystem Management Operations team to monitor the health of your integration and troubleshoot any incidents if they arise.

GET /v1/health

Parent topic:Design Guidelines for the Platform-Managed Flow

GET /v1/health

Returns the health status. There are no request parameters.

Response

Parent topic:Health Check API Response

Response

A successful response returns a HealthResponse object. In the HealthResponse object, there is a services object containing the following object:

HealthItem

HealthItem Fields

Field Name	Format	Required or Optional	Description
id	string	Required	The ID of the health response item. Example: `2b13dac5-cb07-4282-b596-0f427dcfdc52 UUID`.
name	string	Required	The service name.
status	string	Required	The service status.Valid values are: - `Operational` - `Degradation` - `PartialOutage` - `FullOutage` - `Maintenance`
lastUpdated	string (yyyy-mm-ddThh:mm:ssZ)	Required	The date and time the service status was updated.
components	object	Optional	See the ServiceComponent section for more information about what the object contains.

ServiceComponent Fields

Field Name	Format	Required or Optional	Description
id	string	Required	The ID of the service component.
name	string	Required	The service component name.
status	string	Required	The service status of the component.Valid values are: - `Operational` - `Degradation` - `PartialOutage` - `FullOutage` - `Maintenance`
lastUpdated	string (yyyy-mm-ddThh:mm:ssZ)	Required	The date and time the service component status was updated.

Example

Expected results from the Merchant (either example): Merchant returns statuses for each individual sub-service

200 OK {
    "services":
    [
        {
            "id": "1",
            "name": "Add Subscription Callback",
            "status": "Operational",
            "lastUpdated": "2021-11-01T02:33:20"
        },
        {
            "id": "2",
            "name": "Update Subscription Callback",
            "status": "Operational",
            "lastUpdated": "2021-11-01T02:33:20"
        },
        {
            "id": "3",
            "name": "Delete Subscription Callback",
            "status": "Operational",
            "lastUpdated": "2021-11-01T02:33:20"
        }
    ]
}
  
//other valid statuses:  FullOutage, Maintenance in the case of 500 Error

Merchant returns one overall status

200 OK {
    "services":
    [
        {
            "id": "1",
            "name": "M1 callback events",
            "status": "Operational",
            "lastUpdated": "2021-11-01T02:33:20"
        }
    ]
}
  
//other valid statuses:  FullOutage, Maintenance in the case of 500 Error

Code

200: OK Parent topic:GET /v1/health

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

GET /v1/health

Response

HealthItem Fields

ServiceComponent Fields

Example

Code

​GET /v1/health

​Response

​HealthItem Fields

​ServiceComponent Fields

​Example

​Code

GET /v1/health

Response

HealthItem Fields

ServiceComponent Fields

Example

Code