Websockets

For use cases, when polling would be too resource consuming or not enough "real-time", websockets should be used. After successful connection, the client will start receiving messages depending on configuration of the Connector integration in Commander.

Endpoint

Note that protocol of the [PlatformAddress] should be changed to ws(s)://. If [PlatformAddress] starts with http:// then ws:// should be used. If it starts with https:// then wss:// should be used. ClientToken and AccessToken parameter values should be the same as in case of standard API operations. For further details, consult the Authentication section.

Price update event

If the Connector integration is configured to receive price updates, it will receive events whenever a rate price is updated (created). Events are related to rate base price update, price adjustment and category adjustment.

Property

Type

​

Description

Type

string PriceUpdate

required

Type of the event.

Id

string

required

Unique identifier of the update event.

StartUtc

string

required

Start of the price update interval in UTC timezone in ISO 8601 format.