support-access · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: supportAccess · React: <FinBazeSupportAccess />

Create the session#

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

Requirements#

No feature requirements.

Component features#

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

Feature	Default
`decide`	on
`revoke`	on

Options#

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

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`support.access.approved`	`onSupportAccessApproved`
`support.access.declined`	`onSupportAccessDeclined`
`support.access.revoked`	`onSupportAccessRevoked`

Use it#

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

<FinBazeSupportAccess />

const component = instance.create("support-access");
component.mount("#finbaze");