Receive PostMessage API events

Description

The PostMessage API can be used to pickup real time client sided events that occur within the WeSeeDo iframe. This allows you to adjust your apps behaviour to events that are going on inside the video call. An example of this would be the ability to perform some tasks in your app when a video call is ended.

Note: this functionality can only be used when the application uses an iframe.

For server sided events go to Webhooks.

Events

The following events will be send;

Type	Event
WESEEDO_MEETING_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_MEETING_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_MEETING_ENDED	JSON `MessageEvent { data: { type: "WESEEDO_MEETING_ENDED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_PARTICIPANT_JOINED	JSON `MessageEvent { data: { type: "WESEEDO_PARTICIPANT_JOINED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_PARTICIPANT_LEFT	JSON `MessageEvent { data: { type: "WESEEDO_PARTICIPANT_LEFT", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_SCREENSHARE_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_SCREENSHARE_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_SCREENSHARE_STOPPED	JSON `MessageEvent { data: { type: "WESEEDO_SCREENSHARE_STOPPED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_SCREENSHARE_REMOTE_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_SCREENSHARE_REMOTE_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_SCREENSHARE_REMOTE_STOPPED	JSON `MessageEvent { data: { type: "WESEEDO_SCREENSHARE_REMOTE_STOPPED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_PRESENTATION_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_PRESENTATION_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_PRESENTATION_STOPPED	JSON `MessageEvent { data: { type: "WESEEDO_PRESENTATION_STOPPED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_PRESENTATION_REMOTE_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_PRESENTATION_REMOTE_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_PRESENTATION_REMOTE_STOPPED	JSON `MessageEvent { data: { type: "WESEEDO_PRESENTATION_REMOTE_STOPPED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_RECORDING_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_RECORDING_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_RECORDING_STOPPED	JSON `MessageEvent { data: { type: "WESEEDO_RECORDING_STOPPED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_RECORDING_REMOTE_STARTED	JSON `MessageEvent { data: { type: "WESEEDO_RECORDING_REMOTE_STARTED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_RECORDING_REMOTE_STOPPED	JSON `MessageEvent { data: { type: "WESEEDO_RECORDING_REMOTE_STOPPED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`
WESEEDO_MEETING_APPOINTMENT_SCHEDULED This event is fired when a visitor scheduled a meeting using the self-service appointment form.	JSON `MessageEvent { data: { type: "WESEEDO_MEETING_APPOINTMENT_SCHEDULED", data: { meeting_id: "2ea414a7a80efd1176d37a11" } } }`

Event listener

Use the following sample code to listen for incoming events.

JS

window.addEventListener('message', (event) => {
    const eventData = event.data
    if(eventData.type && eventData.type.startsWith('WESEEDO_')) {
        console.log('Received a WeSeeDo postMessage event', eventData.type, eventData.data);
    }
})