engagement-card · FinBaze for Platforms

Components

Kind: element (inline) · Session key: engagementCard · React: <FinBazeEngagementCard />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { engagementCard: { enabled: true } }
  }) { clientSecret }
}

Requirements#

The company must have these features effective: firm_access. A hidden feature makes createEmbedSession fail with FEATURE_DISABLED.

Component features#

Switch these off per session with components.engagementCard.features.

Feature	Default
`end`	on

Options#

Only the common options: appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`engagement.ended`	`onEngagementEnded`

Use it#

import { FinBazeEngagementCard } from "@finbaze/embed-react";

<FinBazeEngagementCard />

const component = instance.create("engagement-card");
component.mount("#finbaze");