You can integrate the Connect SDK into your Cordova app and get it running on iOS and Android through one JavaScript API.

Language: JavaScript, with TypeScript definitions

Availability: Pro, Premium, and Ultimate

Scope: This guide covers installing the plugin and getting the SDK running for development and testing. For push notification setup, see iOS and Android.

Requirements

• Acoustic Connect subscription. Register your app in Connect and get an app key and collector URL. See Generate Connect credentials for integration.
• Development environment. Node.js 20 or later, Cordova CLI 12.0.0 or later (npm install -g cordova).
• iOS: cordova-ios 7.0.0 or later, Xcode 15 or later, and CocoaPods (sudo gem install cocoapods). iOS deployment target 15.1 or later.
• Android: cordova-android 13.0.0 or later, Android Studio with SDK 34 or later, JDK 17. Recent Android Studio releases (Giraffe and later) ship the Gradle IntelliJ plugin only — install a standalone gradle binary and make sure it's on PATH, or cordova-android cannot bootstrap the project's Gradle wrapper.

Initial setup

1. Add the plugin to your Cordova project. This registers it under the Cordova plugin ID co.acoustic.connect.push and adds window.AcousticConnect to your app's JavaScript context.

npx cordova plugin add cordova-acoustic-connect

2. Create ConnectConfig.json at your Cordova project root. Add your Connect credentials to the file.

{
  "Connect": {
    "AppKey": "<your-app-key>",
    "PostMessageUrl": "<your-collector-url>",
    "useRelease": false
  }
}

3. Add ConnectConfig.json to .gitignore to keep your credentials safe.

4. Add platforms and build. On iOS, npx cordova prepare runs pod install — no need to do it yourself, unless CocoaPods reports a stale spec repo (see Troubleshooting).

npx cordova platform add ios
npx cordova platform add android
npx cordova prepare

5. Call AcousticConnect.enable() from your deviceready handler, before any other plugin method.

document.addEventListener('deviceready', async function () {
  await AcousticConnect.enable(
    'your-app-key',
    'https://your-collector-url'
  );
}, false);

Verify the SDK is running

Build and run your app.

Things to know

• Changing useRelease after initial setup. A plain cordova prepare or cordova build will not pick up a new useRelease value. Remove and re-add the plugin instead:

  Shell

  npx cordova plugin rm co.acoustic.connect.push
  npx cordova plugin add cordova-acoustic-connect

• Android auto-initializes; iOS doesn't. Android additionally auto-initializes the SDK from the bundled native config at app launch if enable() hasn't been called yet — a safety net, not a replacement for calling enable() from JS. iOS has no equivalent native auto-init; call enable() explicitly on every platform.

Troubleshooting