Upgrade an integration

Upgrade only when your app is ready. Keep the existing working package and project settings as the rollback baseline.

Choose the target

Select the intended language and exact package in Overview. Compare its complete files with the installed version. Do not treat local.4 and npm beta.4 as the same bytes. Changing a guide does not migrate your app.

Apply and verify

Save the current lockfile, deployed source and server configuration. Keep the project, key, approved origins and stable Preference Secret.

Install the selected package and update backend and frontend together. Connect the current session, atomic storage, generation, presentation and abort hooks. Retain durable journal records and their key-version guard across workers and restarts.

Verify real consent, visible formats, timing, No-Fill, Stop, navigation and matching logs in your nonpayable environment. Restore the previous application version if the checks fail. Never clear consent or bypass a guard to force a pass.

Keep integration paths distinct

The @wavebirdai/api package owns its server and browser adapters. Direct REST uses /v1/placements plus the official renderer. Script Tag uses publishable-key activation. Choose one documented path rather than combining incompatible bootstrap code.

Choose an integration path →

Older SDK and archives

Existing wavebird SDK and local.4/local.5 archive integrations retain their own contracts. A move to @wavebirdai/api is an explicit integration change, not a required automatic migration.

Versions →Advanced SDK →

Need help with your integration?

Share the affected endpoint, request ID, and the behavior you expected. Leave out keys and user content.

Contact the team