dotdigital Engagement Cloud

The dotdigital Engagement Cloud developer hub

Official dotdigital Engagement Cloud APIs documentation

Creating a push notification profile in Engagement Cloud

A push notification profile is a way to let Engagement Cloud know how to communicate with your app via Apple's APNS and Google's FCM push systems, as well as how to authorise a user for push.

You can have only one profile, which can be set up to send push notifications to both Android and iOS devices.

To setup your push notification profile please do the following steps:

  1. Log into Engagement Cloud

  2. Click the icon in the bottom right, and go to Channel management > Push Notification and then click the New profile button

  3. Click in the text box under New profile and enter the name of your app

  4. In the Authentication section, make a note of the values for each field. You'll use these values to create a JSON Web Token (JWT) in your app and pass that token to our SDK to authorise the user for push

  1. Now you need to configure you apps push systems. Depending on the operating systems that your app was built for enter your FCM credentials and/or enter your APNS credentials and return back here after to complete the setup

  2. Click Save

  3. You will now have a value in the 'API space ID' field, which you'll need to initialise an SDK, so note this down for the development team.

You now have configured your push notifications in Engagement Cloud

How return to the setting up push notifications guide and move onto the next step.

Entering your FCM credentials in Engagement Cloud

Our Android SDK uses Firebase Cloud Messaging (FCM) to send push notifications to your Android app users. Therefore, you need to give us some details about your Firebase project.

You need to have the Firebase console open.

If you don't have a Firebase project, create one.

  1. In the Firebase console, click the cog icon and go to Project settings
  1. In the General tab, copy your package name and paste it into the 'Name' field in Engagement Cloud

Don't see your package name?

If you don't see your package name in the General tab, you need to click Add Firebase to your Android app.

Complete only steps 1 and 2 (register your app, and download your config file).

  1. In the Cloud Messaging tab, copy your server key and paste it into the 'Server key' field in Engagement Cloud

Entering your APNS credentials in Engagement Cloud

Our iOS SDK uses the Apple Push Notification Service (APNS) to send push notifications to your contacts. Therefore, you need to configure your APNS token details in order for us to send pushes to your app. dotdigital utilises the APNS tokens rather than APNS Certificates, as the tokens do not expire annually. Instructions for creating an APNS token in the Apple Developer Portal can be found here.

You need to have your Apple Developer Portal open.

If you don't have an app ID that has the 'Push Notifications' service enabled, create one.

  • In your Apple Developer Portal

    • Open the Certificates, IDs & Profiles page.
    • Select the Keys > All option and click the + button to create a new key
    • Enter an appropriate name for the key and ensure the Apple Push Notifications service (APNs) option is selected, and create the key
    • Download the key (.p8 file) and store securely; also note down the Key ID displayed
  • In the Engagement Cloud Push profile setup screen

    • Upload your APNS Key file (.p8) into the Private key field by clicking Choose file
    • In the Key ID field, enter the value of your APNS key's ID
    • In the Team ID field, enter the value of your team ID
    • Save the Push profile configuration

Finding your API space ID

The API space ID is used to initialise our mobile SDKs.

This ID is displayed at the bottom of your push notification profile page as shown below:

Updated about 2 hours ago

Creating a push notification profile in Engagement Cloud


Suggested Edits are limited on API Reference Pages

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