Push

Step-by-step guide to configuring Push as a channel

Push Notifications are messages that pop up on mobile devices. App publishers can send them at any time, even if users are not currenly active on the app or using their device.

🚧

Please Ensure That Your App is Integrated with WebEngage Before Proceeding

Step 1: Enable Push Messaging for your App

Once you've integrated your app with WebEngage, you will need to implement additional configurations to ensure that your users receive the Push Notifications. Depending on the OS, you may need to implement additional configurations like:

🚧

Step-by-step Guides to Enable Push Messaging

Step 2: Configure Channel in Dashboard

As shown below, navigate to the Integrations < Channels < Push section of your dashboard to enable the channel.

Click to enlarge

The section has been divided into two sub-sections, Android and iOS. Here's how you can configure Push for each OS:

For Android

Click to enlarge

As shown above:

Step 1: Add Package Name

The Android app's application ID is also referred to as the Package Name. It can be found in your module (app-level) Gradle file, usually app/build.gradle (example package name: com.yourcompany.yourproject).

Step 2: Add FCM Server Key

The FCM Server Key is a secret code of sorts that enables your WebEngage dashboard to communication with your Firebase project. It enables us to send the Push Campaigns for delivery to your target audience.

  • It can be found under the Firebase Project > Project Settings > Cloud Messaging section in your Firebase Developers Console.
  • Copy + paste it in your WebEngage dashboard.

Step 3: Click Save

Step 4: Click the Plus icon to enable Push for more apps

For iOS

Click to enlarge

As shown above:

Step 1: Select APNs Authentication Type

  • Select Auth Key to connect your app by uploading the Auth Key file created by your tech team.
    • This method allows you to connect multiple app with your WebEngage account as a common Auth Key can be shared by multiple apps, registered to the same Apple Developer Console. (Seting up multi-app support)

🚧

Continue Push configuration via Auth Key

  • Select Certificate to connect your app by uploading the APNs Push Certificate.
    • This method allows you to connect only one iOS app with your WebEngage account.
    • You will need to re-generate the Push Certificate every year.

🚧

Continue Push configuration via APNs Push Certificate

If 'Auth Key' is selected at Step 1

Click to enlarge

Step 2: Upload Auth Key file

As shown above, click the Upload button to add the Auth Key file.

  • You can download the Auth Key file from the Certificates, Identifiers & Profiles > Keys section in the Apple Developer Console. (Please don't rename the file).

Step 3: Add Team ID

The Team ID is located under Membership > Team ID in the Apple Developer Console.

Step 4: Add Bundle Identifier

The Bundle Identifier can be found in Xcode.

Step 5: Select Default Push Mode

As shown in the above visual:

  • Select Development to test Push integration for an iOS app that's currently under development (not available for download at the app store).

  • Select Production to start sending Push Notifications to all users who have downloaded your iOS app.

Step 6: Click Save

Step 7: Click the Plus icon to enable Push for more iOS apps

If 'Certificate' is selected at Step 1

Please get in touch with your tech team to upload the Certificate and complete configuration. APNs Push Certificate can be created through the Certificates, Identifiers & Profile > Identifiers > App ID section in the Apple Developer Console. (Step-by-step guide)

Step 3: Test Push Integration

Test your integration by sending a Push Campaign to an internal segment (including only yourself and your teammates). (Step-by-step Guide to Creating Segments)

👍

Congratulations!

You're now ready to engage users through Push Notifications.

Please feel free to drop in a few lines at [email protected] in case you have any queries or feedback. We're always just an email away!

Updated 4 days ago


So, what's next?

Let's help you launch your first Push campaign!

Getting Started with Push Notifications

Push


Step-by-step guide to configuring Push as a channel

Suggested Edits are limited on API Reference Pages

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