Client Events

9min
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;
};
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
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: 
JSON
{
  "type": "action",
  "action": "unsubscribe",
  "source": location.pathname
}
{
  "type": "action",
  "action": "unsubscribe",
  "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
﻿
Co-branded configuration
SDK URL query params
Client Events

Event Types

Typescript types

Introduction

Mandatory events

List of mandatory events:

﻿

Optional events
