Skip to content

docs: Add form lifecycle event hooks section to README #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ajaysubra wants to merge 4 commits into
base: master
Choose a base branch
from
+43 −0
Open

docs: Add form lifecycle event hooks section to README #517

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
793a72f
Merge branch 'master' of github.com:klaviyo/klaviyo-swift-sdk
ajaysubra Feb 20, 2026
129fc83
docs: Add form lifecycle event hooks to README
ajaysubra Feb 25, 2026
b4fe950
docs: add formName to form lifecycle handler example
ajaysubra Mar 3, 2026
d981d08
Update example code, add release version, add TOC line
belleklaviyo May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
- [Setup](#setup-1)
- [In-App Forms Session Configuration](#in-app-forms-session-configuration)
- [Unregistering from In-App Forms](#unregistering-from-in-app-forms)
- [Monitoring Form Lifecycle Events](#monitoring-form-lifecycle-events)
- [Geofencing](#geofencing)
- [Prerequisites](#prerequisites-2)
- [Setup](#setup-2)
Expand Down Expand Up @@ -746,6 +747,48 @@ KlaviyoSDK().unregisterFromInAppForms()

Note that after unregistering, the next call to `registerForInAppForms()` will be considered a new session by the SDK.

### Monitoring Form Lifecycle Events
Copy link
Copy Markdown
Contributor

@belleklaviyo belleklaviyo Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also add this to the table of contents at the top

Copy link
Copy Markdown
Contributor

@evan-masseau evan-masseau May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1


> ℹ️ Form lifecycle events are available in SDK version 5.3.0 and higher

You can register a handler to track when forms are shown, dismissed, or when users tap call-to-action buttons. This is useful for sending form engagement data to third-party analytics platforms like Amplitude, Segment, or Mixpanel.

```swift
import KlaviyoForms

KlaviyoSDK().registerFormLifecycleHandler { event in
switch event {
case .formShown(let formId, let formName):
// Track when a form is displayed
Analytics.track("Klaviyo Form Shown", properties: [
"formId": formId ?? "",
"formName": formName ?? ""
])
case .formDismissed(let formId, let formName):
// Track when a form is dismissed (user, timeout, or programmatic)
Analytics.track("Klaviyo Form Dismissed", properties: [
"formId": formId ?? "",
"formName": formName ?? ""
])
case .formCtaClicked(let formId, let formName, let buttonLabel, let deepLinkUrl):
// Track when a user taps a call-to-action button
Analytics.track("Klaviyo Form CTA Clicked", properties: [
"formId": formId ?? "",
"formName": formName ?? "",
"buttonLabel": buttonLabel ?? ""
])
}
}
```

The handler is called on the main thread and will receive events for all form interactions. To unregister the handler:

```swift
KlaviyoSDK().unregisterFormLifecycleHandler()
```

**Note:** The handler is optional and does not affect normal form functionality. Forms will continue to display and track analytics in Klaviyo regardless of whether a handler is registered.

## Geofencing

> Geofencing support is available in SDK version 5.2.0 and higher.
Expand Down
Loading