Type alias FormLifecycleEvent

Discriminated union representing a form lifecycle event.

Each variant carries contextual data about the form, and the type field serves as the discriminant. Use a switch on event.type to narrow the type and access variant-specific fields like buttonLabel and deepLinkUrl.

Example usage:

Klaviyo.registerFormLifecycleHandler((event) => {
  switch (event.type) {
    case FormLifecycleEventType.Shown:
      console.log(`Form shown: ${event.formId}`);
      break;
    case FormLifecycleEventType.Dismissed:
      console.log(`Form dismissed: ${event.formId}`);
      break;
    case FormLifecycleEventType.CtaClicked:
      console.log(`CTA clicked: ${event.buttonLabel}, deep link: ${event.deepLinkUrl}`);
      break;
  }
});
Copy