Troubleshooting

1. Where do I find the WebEngage license code for SDK integration?

You will find your License Code on WebEngage dashboard. Log in to your WebEngage dashboard and go to Account Setup section, as highlighted in the image below. Note that your License Code might start with tilde (~).

It is the value of Info.plist key: WEGLicenseCode

2. How do I pass the device token to WebEngage SDK if I am manually registering APNs?

WebEngage SDK will automatically receive the token when it is received via APNs registration call, provided you have initialized the SDK properly.

In case you are making the APNs registration manually, you would receive the device token in your app’s AppDelegate callback application:didRegisterForRemoteNotificationsWithDeviceToken:.

You may implement this callback for your own custom handling. WebEngage SDK automatically intercepts your callback method to receive the device token.

📘

For manually registering your app with APNS, you need to call appropriate initialization API with the auto-register flag as NO (or false). Refer to Initialization APIs.

3. How do I verify the integration status?

Enable Verbose logging by adding WEGLogLevel key in Info.plist file and set its value to VERBOSE.

Launch your app through Xcode and verify the logs. Search for the log statement: "SDK Integration Verification complete" in the Xcode console. In case it's there, your SDK integration is likely to be complete and correct, unless your configuration values are wrong. If you don't see this statement, continue with the troubleshoot.

📘

Double-check your license code in Info.plist (WEGLicenseCode key) against the WebEngage dashboard.

4. I didn't the log message, 'SDK Integration Verification complete'. How do I troubleshoot?

If you do not find a log message saying 'SDK Integration Verification complete', you should get one saying SDK Integration is not complete. Validations failed. You may get other specific error message(s) before this log. In that case, act according to the instructions in the error message.

5. Users/Events not showing up in dashboard even after successful SDK integration. How do I troubleshoot?

Please go over the following checklist:

  1. Make sure you have successfully integrated WebEngage SDK in your app.

  2. Verify that your license code is correctly configured in your Info.plist file.

  3. Check the logs for the error messages "Error while reporting event to network" and "Error: Timeout occurred while waiting for events response in flush". The error messages may also provided some context of the error occurred while trying to sync events.

In case handling the error is out of the scope of your app, let us know at [email protected] with the detailed console logs after enabling Verbose logging in Info.plist.

📘

Successful Event Reporting from SDK

In case events are successfully sent from the SDK, console should print a message Reported Events to Network in the Verbose mode. In case you observe this log on the console but events/users not showing up on dashboard, contact support at [email protected].

6. How do I know which version of the WebEngage iOS SDK is being used in my app?

In case you have integrated WebEngage using CocoaPods, check the Podfile.lock file in your project directory. This file stores the WebEngage SDK version.

For Direct Integration, look for the Info.plist file in the WebEngage.framework directory (within the downloaded and extracted .zip file). For the WebEngage SDK version, check the file for the property named Bundle versions string, short if viewing in the visual editor. Check for CFBundleShortVersionString when viewing in the source code editor.

7. What's the latest available version of the WebEngage iOS SDK?

You can check this link for the latest publicly released version of the SDK.

Other than that we also make internal beta releases. Beta releases are only available through CocoaPods integration. You can get the latest beta released SDK version details here.

8. How do I update to the latest WebEngage iOS SDK version?

  • If you are using CocoaPods, go to the your project director or the directory holding the Podfile in the terminal and execute:
pod update WebEngage

The command should show up the latest version being installed. Verify from here if the downloaded version is actually the latest version.

  • In case the above step doesn't download the latest version of the SDK, run:
pod repo update

And then again run:

pod update WebEngage
  • For Direct Integration, first check the version of iOS SDK you've installed. If you are not using the latest version, download the latest version from here and replace the existing one under Linked Frameworks and Libraries section of the project settings. Refer Direct Integration under iOS SDK Setup.

We hope this has helped you integrate your iOS app with WebEngage. Please feel free to drop in a few lines at [email protected] in case you have any further queries. We're always just an email away!

Updated 10 months ago


Troubleshooting


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.