Client Events

event types the boom sdk supports two types of events action and analytics action this action type requires developers to handle the event analytics no action required typescript types typescipt event type type emittedevent = analyticsevent | actionevent; // pageidentifier page name type pageidentifier = string; type analyticsevent = { type "analytics"; action "pageview" | "click"; source pageidentifier; message? string; }; type actionevent = { type "action"; action "close" | "auth error" | "plaid link handoff"; source? pageidentifier; message? string; }; introduction client side emitted events have four key attributes type , action , source , and message type differentiates between mandatory events ( action ) and optional events ( analytics ) action provides key information about the event type possible values close , auth error , plaid link handoff , click , pageview , connect bank source indicates the location pathname where the event was called message optional attribute providing additional information about the event (e g , “enrollment submitted”, error payload message, “upsell clicked”, “continue button clicked”) mandatory events type action events are mandatory to handle in your app for the optimal user experience list of mandatory events close description the user clicked the “close icon” in the sdk boom sdk must be closed payload { "type" "action", "action" "close", "source" pathname } auth error description provided token failed authentication boom sdk must be closed message contains information on why authentication failed payload { "type" "action", "action" "auth error", "message" errormessage } plaid link handoff description user initiated plaid link handoff boom sdk must be closed payload { "type" "action", "action" "plaid link handoff", "source" location pathname } unsubscribe description upon request, the boom team can enable a self service unenroll button in the sdk this allows users to immediately stop reporting if enabled, you should close the sdk upon receiving this event and update your database accordingly payload { "type" "action", "action" "unsubscribe", "source" location pathname } connect bank contact boom to enable this event description user initiates adding a bank account the boom sdk must be closed before proceeding you should open plaid and pass the connected bank information to boom payload { "type" "action", "action" "connect bank", "source" location pathname, "message" "connect bank for past reporting" } pay rent handoff contact boom to enable this event description used in cases where the customer pays rent through your app and you want to own the process the boom sdk must be closed before starting this flow and then, you can launch your process payload { "type" "action", "action" "pay rent handoff", "source" location pathname } optional events type analytic events are optional pageview description indicates that the user is on a certain page page identifier is passed in source click description user clicked an interactive element usually contains a message possible messages "upsell clicked" "continue button clicked" "enrollment submitted" possible sources /plaid connect /hub /issues/upload lease /rent reporting/onboarding/ \ view \ view could be one of intro plaid confirm personal info confirm lease info property manager details check out /rent reporting id /settings/linked accounts /settings