Form Filling SDK Event Handling

Subscribe to FormFillingClient emitter events for analytics, logging, and persistent handlers across multiple sessions

This example shows how to subscribe to Form filling SDK events with client.on(). You register listeners once when you create FormFillingClient, then use them for analytics, logging, or saving background results across every session on the page.

Callbacks such as onSubmit run for one session at a time. Event listeners stay active until you unsubscribe. Refer to Events for when each event fires.

JavaScript

import { FormFillingClient, SukiFormFillingError } from "@suki-sdk/form-filling";

const client = new FormFillingClient({ authManager });

const unsubscribers = [
  client.on("form-filling:ready", () => {
    analytics.track("form_filling_ready");
  }),
  client.on("form-filling:session-started", (payload) => {
    analytics.track("form_filling_session_started", {
      ambient_session_id: payload.ambient_session_id,
      correlation_id: payload.correlation_id,
    });
  }),
  client.on("form-filling:submitted", (result) => {
    analytics.track("form_filling_submitted", {
      ambient_session_id: result.ambient_session_id,
      form_count: result.structured_data.generated_values.length,
    });
  }),
  client.on("form-filling:background-submitted", (result) => {
    persistToBackend(result);
  }),
  client.on("form-filling:error", (err) => {
    if (err instanceof SukiFormFillingError) {
      analytics.track("form_filling_error", { code: err.code, reason: err.reason });
    }
  }),
];

// On app teardown:
// unsubscribers.forEach((off) => off());

form-filling:submitted removes the iframe for a foreground session. form-filling:background-submitted does not: it means results arrived for a session that is no longer the foreground session (for example after replace or reopen), not merely that processing took longer than 60 seconds.

Next steps

Events - All event names and lifecycle.

Webhook handler - Server-side saves.

EHR handoff - Map structured_data to your EHR.