WebSocket Monitor REST API

3.15.0

This API is designed for IT administrators
This API must use JWT authentication
The JWT token must be for an authorized mobile user

The WebSocket Monitor REST API was developed to allow IT administrators to monitor and verify that the WebSocket connection is available and working. This API is typically used in the case where the IT monitoring software being used does not support WebSocket connections.

WebSockets are used by the mobile application for communicating and exchanging data with the ServiceMobility ESB.

Related pages:

Monitoring REST APIs

Resource URLs

GET /seiapi/v3/Monitor/WebSockets

Supported HTTP Methods

Method	Description
GET	Verifies that the WebSocket connection is still available and active.

HTTP Headers

Header

Description

Content-Type

Specifies the body content format that will be submitted and expected to be returned.

Valid values are:

application/json

x-access-token

Must contain a valid JSON Web Token (JWT) that is also valid as a mobile user.

HTTP Response

Response Codes

HTTP Code	Description
200	OK. The WebSocket connection is active and working properly.
401	Gone. The WebSocket connection is no longer available.
500	Server Error. There is an error with this API itself or the server hosting this API. This does not mean that WebSockets is not available.

ServiceMobility 3

WebSocket Monitor REST API

Analytics

Supported HTTP Methods

HTTP Headers

HTTP Response

Response Codes

Related content