reminders · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: reminders · React: <FinBazeReminders />

Create the session#

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

Requirements#

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

Component features#

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

Feature	Default
`send`	on
`close`	on

Options#

Passed to instance.create("reminders", options) or as props.

Option	Type
`reminderId`	`string`	Open this reminder instead of the list.

Every component also takes appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`reminder.sent`	`onReminderSent`
`reminder.closed`	`onReminderClosed`
`reminder.selected`	`onReminderSelected`

Use it#

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

<FinBazeReminders />

const component = instance.create("reminders");
component.mount("#finbaze");