On-site Gateway 1.0.0
A Websocket API for channels to and receive push data
Schemas
acknowledgement
Type:
acknowledgementErrorCode
Type: string
actionType
Type: string
clientMessage
| Name | Type | Description |
|---|---|---|
action |
string |
correlationId
Type: string
displayType
Type: string
ping
pong
relevantMessagingMessage
relevantMessagingPayload
| Name | Type | Description |
|---|---|---|
displayType |
displayType | |
params |
Parameters for this message | |
template |
The template content, may contain placeholders which will need to be resolved from params | |
templateId |
string | The ID of the template that should be used to render the message |
urn |
string | The urn of the message |
serverMessage
| Name | Type | Description |
|---|---|---|
messageType |
string |
subscribe
Type:
subscriptionErrorCode
Type: string
subscriptionId
Type: string
subscriptionStatus
topic
Type: string