This method allows you to report a “functional event”. Through functional events you can signal moments within the user’s session that are relevant from a functional standpoint and that by default, our tracker can’t pick up and flag on its own. An example of a functional event would be the user adding an item into the shopping cart. While our tracker will be able to record the action, it would not know to flag it as a relevant event within the timeline of your session. However, thanks to this method, you can do it manually.

See custom events for more details.

OpenReplay.instance.event(String name, [Object? payload])

• name: String: The name of the event. This name can be used for filtering and searching purposes inside the OpenReplay platform.
• payload: Object?: The content of the event. A String is sent as-is; anything else is JSON-encoded, falling back to toString() if it is not encodable. Omit it to send an empty payload.

OpenReplay.instance.event('checkout_started', {'cart': 3, 'currency': 'EUR'});
OpenReplay.instance.event('promo_banner_dismissed');

If you have any questions about this process, feel free to reach out to us on our Slack or check out our Forum.