Manage Your Health Check Endpoint

A health check endpoint allows the Operations team to monitor the health of your integration and quickly troubleshoot any incidents that may arise. Once you provide a health check endpoint, the Platform Health Status page will display the status of your integration alongside the general platform status and the status of other partnered organizations. In the Health Check space, you can do the following:

Add health check endpoints
Edit health check endpoints
Delete health check endpoints

Navigate to Platform Settings > Health Check. The Health Check Endpoints page appears.
Choose what you’d like to do:
- To add a health check endpoint, select Click here to set up a Health Check Endpoint. The New Health Check Endpoint box appears. Refer to the tables below for guidance regarding the fields. When you’re done, select Create Endpoint. The endpoint has been successfully created. Note: It can take up to 72 hours for the endpoint to be posted to the Platform Health Status page.
- To edit a health check endpoint, select the three dot menu for the health check endpoint and then select Edit Endpoint. The Edit Health Check Endpoint box appears. Refer to the tables below for guidance regarding the fields. When you’re done, select Save. Your changes have been saved. Note: It can take up to 72 hours for changes to the endpoint to be posted to the Platform Health Status page.
- To delete a health check endpoint, select the three dot menu for the health check endpoint and then select Delete Endpoint. The Delete Health Check Endpoint box appears. Select Delete Endpoint. The endpoint has been deleted successfully.

Health Check Endpoint Field Details

Parent topic:Health Check

Health Check Endpoint Field Details

Field Name	Guidance	Required or Optional
Endpoint Name	Enter a name for the endpoint. The name can contain any of the following characters:- a-z, A-Z - 0-9 - !@#$%^&*-() - spaces	Required
Endpoint Description	Enter a description of the endpoint. The description can contain any of the following characters:- a-z, A-Z - 0-9 - !@#$%^&*-() - spaces The description is limited to 500 characters.	Optional
Endpoint URL	Enter a valid URL for the endpoint. An example of a valid URL is https://www.example.com/endpoint.	Required
Credentials	You can secure the endpoint by adding credentials. Partner Ecosystem Management recommends that you add credentials, but they are not required. To use credentials, you need to first obtain them for your system. You must choose one of the following options:- No credentials - Username and password - API key - OAuth2	Required
Parent topic:Manage Your Health Check Endpoint

Home

Introduction

For Merchants

For Resellers

Partner Ecosystem Management

Commerce Engine

Storefront Experience

APIs

Health Check Endpoint Field Details

​Health Check Endpoint Field Details

Health Check Endpoint Field Details