WebSockets provides another way to communicate with Mews, for special use cases where polling using API Operations is too resource consuming, and event-driven Webhooks are not sufficiently real-time. A WebSocket is an open connection over which Mews can send event messages as the events occur. After you make a successful WebSocket connection to Mews, you will receive event messages according to the configuration of your integration in Mews Operations. For a comparative overview of Operations vs Webhooks vs WebSockets, see Ways to communicate.
Authentication is done using the same combination of
AccessTokenas used for standard API operations. These tokens must be sent as cookies together with the connection request. Most WebSocket client libraries support this. For more information about client tokens and access tokens, see Authentication.
Cookie: ClientToken=E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D; AccessToken=C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Note: There can't be any spaces around
=in the Cookie value as this would prevent successful WebSocket connection.
- ClientToken - Unique token per integration which will be provided to you by Mews upon successful certification.
- AccessToken - Unique token per enterprise. Can be provided to you by the enterprise admin.
Depending on the event
Type, it is one of the following:
If the integration is configured to handle commands for some devices, it will receive events whenever a command is created or updated.
If the integration is configured to receive reservation updates, it will receive events whenever any change is made to a reservation (created, updated, canceled, etc.).
If the integration is configured to receive resource updates, it will receive events whenever a change is made to a resource (created, renamed, state updated).
If the integration is configured to receive price updates, it will receive events whenever a rate price is created or updated. Events are related to base price updates, price adjustments and category adjustments.