Skip to main content

Front messages

Using this API, you can send messages to a particular instance of Retail Operations opened in the client navigator.

Front methods​

Send Event​

Sends an event to a specified opened instance (connectionID) of the front.

POST/api/externals/v1/front/{connectionID}/sendEvent

Arguments​

  • connectionID (long): (provided in the path): The Connection ID of the front-end instance to which the event will be sent

Body​

The json event message to be sent:

{
    "event": string,   // Name of the event
    "content": object  // Depends on the event type
}

Several examples of supported messages can be found here.

Response​

{
  "success": boolean,
  "message": string,
}