Web Changelog

This minor release adds support for URL triggers. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Add support for triggering IAX via URL triggers

This patch release corrects an issue where, in some cases, the button tap event on a form submission button would be reported twice. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fix duplicate In-app button tap events being emit on buttons with a form submission/validation action.
• Update to latest Scenes renderer.

This minor release adds full support for email and SMS collection and registration in Scenes. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Add MSISDN validation support
• Support asynchronous form validation in Scenes
• Update to latest Scenes renderer
• Add scene page history to In-App reporting context

This patch release fixes an issue that can cause contact remote data listings to fail in some cases, which may cause Journey to In-App-Experience messages to fail to display. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fix error when parsing contact remote data

This patch release fixes an issue that can cause In-App Automation “session start” triggers to be missed on first channel creation. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fix race condition between event processing and remote-data refresh which may cause triggers to be skipped.

This minor release adds support for setting associated identifiers and adding a delay between IAX displays. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Add support for setting and modifying associated identifiers
• Set the IAX display delay programmatically
• Add a config option to insert a delay between IAX displays

This minor release adds granular control for SDK features via the new Privacy Manger. This release also includes some improvements to data storage and reporting events, improving SDK behaviour while on unreliable network connections. This change is fully backward compatible and does not require any update to existing integrations. Any integrations which were using the existing analytics or data collection controls will have their calls mapped to the Privacy Manager, with their behaviours retained.

Changes

• Adds a Privacy Manger for granular control over SDK feature enablement/disablement
• Migrates all remaining analytics events to the offline-tolerant event reporter queue
• Adds support for running In-App Experiences with analytics disabled
• Supports updating trigger definitions for In-App Experiences at runtime
• Removes browser details from channel registration when analytics are disabled

This patch release fixes an issue where push notification click events for reporting may not be sent if the web app is running as a TWA (trusted web activity) on Chrome for Android. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Adjust push notification click event handling

This patch release fixes a rare issue where an out-of-date local definition for an In-App Experience could cause a display to be skipped rather than retried later when using server-side segmentation. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fix invalidation handling for IAA schedules, and attempt to fetch the latest version before schedule preparation

This patch release fixes an issue feature flags and preference centers where attempting to load them before a channel was created would incorrectly succeed, returning inaccurate information. This change does not require any update to existing integrations.

Changes

• Ensure remote data cannot be loaded before the SDK is active

This patch release fixes an error which might be raised by some integrations before a channel is created. This error would not cause any misbehavior of the SDK, but may have shown up in error reporting. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fixes an error raised when attempting to refresh remote data before a channel is created

This minor release updates the Web SDK’s fetching of remote data to match our mobile SDK behavior, and to improve its operation in some deployment scenarios such as single page applications. This release also contains some data storage and reporting event improvements. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Improves remote data handling to better match mobile SDK behaviors
• Supports refreshing remote data definitions during runtime
• Output a warning in the console when configuration does not match between the service worker and the current instance of the SDK
• Updates session and notification click event handling to be offline tolerant
• Consolidates data storage into IndexedDB to support more runtime environments
• Prepares for upcoming Airship feature releases

This patch release updates push notification display handling to work around an issue on Chrome when running on macOS 15, which could cause notifications to not handle click events. This change is fully backward compatible and does not require any update to existing integrations. Note that this fix will not take effect until the service worker is updated on a client device, and will not fix any existing displayed notifications which exhibit the issue.

Changes

• Re-order and handle notification display tasks serially to work around https://issues.chromium.org/issues/370536109 

This patch release updates push notification display handling to work around an issue on Chrome when running on macOS 15, which could cause notifications to not handle click events. This change is fully backward compatible and does not require any update to existing integrations. Note that this fix will not take effect until the service worker is updated on a client device, and will not fix any existing displayed notifications which exhibit the issue.

Changes

• Re-order and handle notification display tasks serially to work around https://issues.chromium.org/issues/370536109 

This minor release adds support for Feature Flag A/B Testing. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Adds support for feature flag experimentation features

This patch release updates the In-App Experience renderer to support new features. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Update In-App experience renderer to latest version

This patch release adds UC Browser and Samsung Internet for Android when setting device properties on a web channel. These will appear as uc and samsung respectively.

Changes

• Update browser property extraction library to latest version
• Allow UC Browser and Samsung Internet for Android as valid browser names

This minor release adds new features for In-App experiences. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Supports email form fields for In-App Experiences
• Adds support for setting custom display breakpoints for In-App Experiences, allowing your display overrides to match your web application’s breakpoints
• Consolidates some library code to reduce the size of some SDK bundles

This patch release fixes an issue where different versions of the SDK running in different tabs/windows could cause a loop when refreshing In-App Experience definitions.. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Ignore remote data refresh messages if the source SDK version doesn’t match

This patch release fixes an In-App Experience rendering issue when using percentage widths for some elements. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Updates to latest In-App Experience renderer

This patch release fixes an issue with on-device segmentation which could cause inaccurate audience checks. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Fixes an issue when removing tags from local device tag storage

This patch release improves the behavior of the SDK when multiple tabs/windows are open to the same site, and reduces the number of situations where a channel’s contact would change, creating conflicts. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Improves consistency of the web SDK when multiple site instances are loaded across tabs/windows
• Updates to the latest In-App Experience renderer to support upcoming features
• Improves handling of contacts to reduce the number of cases where a conflict would occur

This patch release resolves an issue with mobile Safari opt-outs. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Works around a mobile Safari issue causing unintended opt-outs in some cases

This patch release resolves an issue with mobile Safari opt-outs, and fixes a rare race condition in determining which contact a new channel belongs to. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Works around a mobile Safari issue causing unintended opt-outs in some cases
• Fixes a rare issue where multiple instances of the SDK simultaneously registering could result in two contact IDs

This patch release resolves an issue where Story indicators for previous pages were not using the correct color. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Ensure page indicators for past story pages use the filled color instead of the unfilled color

This minor release improves gesture/swipe detection in Scenes, and ensures that in-app experiences that are loaded from a previous session respect their priority ordering. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Sort schedules in priority order when rehydrating in-app experiences
• Use latest in-app experience renderer for updated gesture detection

This minor release adds SDK support for personalizing In-App Experiences using custom event data. This feature will be enabled in the platform in the near future. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Send triggering event data when performing server-side resolution of an In-App Automation payload

This patch release fixes conversion events for permission changes (such as push opt-in) when using Scenes, and improves subscription list loading for channels and contacts. This change is fully backward compatible and does not require any update to existing integrations.

Note that v2.3.2 was an internal-only release, and was never released publicly.

Changes

• Emit conversion events for permission changes (notifications, location) as a result of scene opt-ins
• Cache subscription list listings for channels and contacts

This patch release fixes issues with non-push channel registration in mobile Safari. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Check for presence of pushManager before access on channel registration, as it is not present in some mobile Safari versions unless added to the home screen

This minor release adds support for inline text formatting in In-App Experiences, and improves message priority handling in some cases. This change does not require any update to existing integrations.

Changes

• Update to the latest In-App Experience renderer for inline text formatting support
• Ensure correct message priority is used when displaying ongoing messages

This patch release improves In-App Experiences display handling and delegation to ensure frequency limits are accurately applied in all situations. This change is fully backward compatible and does not require any update to existing integrations.

Changes

• Perform rate limit incrementing later in the display process to ensure only actual views are counted against frequency limits
• Only ask display delegates for display permission prior to actual display
• Update to latest In-App Experience renderer

This patch release fixes some issues present in channel registration and In-App Experiences. This change is fully backward compatible and does not require any update to existing integrations.

Note that v2.2.19 was an internal-only release, and was never released publicly.

Changes

• Improves caching of feature flag checks for server-side audiences
• Fixes a rare issue where a user manually clearing their local browser storage could lead to multiple channels being created for a single browser
• Fixes an issue in In-App Experiences where certain types of media would fail to preload, causing the display to be suspended

Version 2 of the Airship Web SDK, which adds new features including In App Experiences for web!

For a full explanation of changes as well explanations of each feature, see Implementing Web SDK v2 as well as our migration guide.

v2.2.18 is the first public release of the Airship Web SDK version 2, all previous released under major version 2 were not public.

New Features

• In-App Experience features, including Scenes and Surveys
• Register browsers as Channels without requiring notification opt-in, allowing In-App Experiences, Named User association, event tracking, and all the features you’re accustomed to in our mobile SDKs

Removed Support

Some features were removed from the SDK; if you still rely on these features, then you will wish to stay on the v1 SDK:

• Support for HTTP setups; this is also referred to as “secure bridge”. The v2 SDK requires HTTPS on all pages.
  • The registration page plugin has been removed, as it was only needed for these setups
• Multi-domain setups are not supported; this is where a single registration was shared across multiple domains or subdomains.
• APNs Safari is no longer supported, as Apple started supporting VAPID push in Safari 16 on macOS 13 and above, which was released October 2022.

Known Issues

• APNs Safari registrations are not automatically migrated to VAPID, and must be re-registered using the sdk.register() method.
• AMP support is untested and not supported for new integrations

• Removes early access feature flag support; this feature will return in a later release

This release fixes some minor defects. It is fully backward compatible with existing installations.

• fix some issues with autogenerated docs for custom events
• introduces a workaround for chrome incorrectly reporting web push permission status in some cases
• transpile external modules for ES5, matching the rest of the SDK’s compilation target

• fixes mobile Safari “standalone” detection inadvertently including desktop Safari 17

• Fix an issue when re-evaluating a feature flag audience condition
• Support emitting feature flag interaction events