Component Events

Everee Embed Components use events to communicate with your host application. You should listen for these events as they include important information and helpful errors.

In order to listen for events, you'll need to give us a way to communicate. This can be done one of two ways. If you're using a UI library to present "web-view" components, you'll likely need to use that library's unique approach to attach an event listener, JavaScript message channel, or similar. If you're using an <iframe> element, you can provide a communication channel directly. See below for examples.

Embed Component events have data payloads with the following shape:

{
  "eventType": "EVENT_TYPE",
  "error": false,
  "errorCode": "EMB-101",
  "errorMessage": "Error message text",
  "eventHandlerName": "Your provided 'eventHandlerName'"
}

Embed Components can broadcast the following events:

Successful registration

Once an event handler has been successfully registered with the Embed Component, your handler will receive an initial event with eventType: "MESSAGE_PORT_REGISTERED". This event will be delivered strictly before any other events are published from the Component, and confirms that the Component is able to communicate with your host application.

Error codes

You may see errors during development or production. Use these error codes below to identify and resolve issues.