{"_id":"5d728641586a210011bf9475","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"5b34ded01cb20f000391ad6d","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-06-28T13:12:48.898Z","from_sync":false,"order":1,"slug":"push-notifications","title":"Push notifications"},"user":"55114030a226890d00911658","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-06T16:16:01.085Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"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.\n\nYou can have only one profile, which can be set up to send push notifications to both Android and iOS devices.\n\nTo setup your push notification profile please do the following steps:\n\n1. Log into Engagement Cloud\n\n2. Click the <img src=\"https://files.readme.io/e056d4c-person_and_cog.PNG\"/> icon in the bottom right, and go to **Channel management** > **Push Notification** and then click the **New profile** button\n\n3. Click in the text box under *New profile* and enter the name of your app\n\n4. 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)](doc:creating-a-json-web-token) in your app and pass that token to our SDK to authorise the user for push\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/744188a-Channel_management_push_notification_profile_-_Authentication.png\",\n        \"Channel management_push notification profile - Authentication.png\",\n        600,\n        256,\n        \"#ebebe9\"\n      ]\n    }\n  ]\n}\n[/block]\n5. Now you need to configure you apps push systems. Depending on the operating systems that your app was built for [enter your FCM credentials](#section-entering-your-fcm-credentials-in-engagement-cloud) and/or [enter your APNS credentials](#section-entering-your-apns-credentials-in-engagement-cloud) and return back here after to complete the setup\n\n6. Click **Save**\n\n7. You will now have a value in the ['API space ID' field](doc:creating-a-push-notification-profile#section-finding-your-api-space-id), which you'll need to initialise an SDK, so note this down for the development team.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"You now have configured your push notifications in Engagement Cloud\",\n  \"body\": \"How return to the [setting up push notifications guide](doc:setting-up-push-notifications-new#section-embed-our-sdk-in-your-app) and move onto the next step.\"\n}\n[/block]\n## Entering your FCM credentials in Engagement Cloud\n\nOur Android SDK uses [Firebase Cloud Messaging (FCM)](https://firebase.google.com/docs/cloud-messaging/) to send push notifications to your Android app users. Therefore, you need to give us some details about your Firebase project.\n\nYou need to have the [Firebase console](https://console.firebase.google.com/u/0/?pli=1) open.\n\nIf you don't have a Firebase project, create one.\n\n1. In the Firebase console, click the **cog **icon and go to **Project settings**\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/c1a85db-Firebase_project_settings.jpg\",\n        \"Firebase_project settings.jpg\",\n        300,\n        142,\n        \"#e2e6e6\"\n      ]\n    }\n  ]\n}\n[/block]\n2. In the **General **tab, copy your package name and paste it into the 'Name' field in Engagement Cloud\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Don't see your package name?\",\n  \"body\": \"If you don't see your package name in the **General** tab, you need to click **Add Firebase to your Android app**.\\n\\nComplete only steps 1 and 2 (register your app, and download your config file).\"\n}\n[/block]\n3. In the **Cloud Messaging** tab, copy your server key and paste it into the 'Server key' field in Engagement Cloud\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d0423b4-Firebase_server_key.jpg\",\n        \"Firebase_server key.jpg\",\n        600,\n        196,\n        \"#eeeeee\"\n      ]\n    }\n  ]\n}\n[/block]\n## Entering your APNS credentials in Engagement Cloud\n\nOur iOS SDK uses the Apple Push Notification Service (APNS) to send push notifications to your contacts. Therefore, you need to give us your APNS details.\n\nYou need to have your Apple Developer Portal open.\n\nIf you don't have an app ID that has the 'Push Notifications' service enabled, create one.\n\n1.  In your Apple Developer Portal, create a new certificate of type **Apple Push Notification Service SSL (Sandbox and Production)** and upload that certificate to the 'Private key' field on your Engagement Cloud profile page\n\n2. In the 'Key ID' field in Engagement Cloud, enter the value of your [private key's ID](https://developer.apple.com/account/ios/authkey/)\n\n3. In the 'Team ID' field in Engagement Cloud, enter the value of your [team ID](https://developer.apple.com/account/#/membership/)\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5a640ab-Channel_management_push_notification_profile_-_APNS.png\",\n        \"Channel management_push notification profile - APNS.png\",\n        600,\n        210,\n        \"#eaeae9\"\n      ]\n    }\n  ]\n}\n[/block]\n## Finding your API space ID\n\nThe API space ID is used to initialise our mobile SDKs.\n\nThis ID is displayed at the bottom of your push notification profile page as shown below:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d18fc17-Channel_management_push_notification_profile_-_API_space_ID.png\",\n        \"Channel management_push notification profile - API space ID.png\",\n        764,\n        158,\n        \"#e6e6e5\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"creating-a-push-notification-profile-new","type":"basic","title":"Creating a push notification profile in Engagement Cloud"}

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 <img src="https://files.readme.io/e056d4c-person_and_cog.PNG"/> 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)](doc:creating-a-json-web-token) in your app and pass that token to our SDK to authorise the user for push [block:image] { "images": [ { "image": [ "https://files.readme.io/744188a-Channel_management_push_notification_profile_-_Authentication.png", "Channel management_push notification profile - Authentication.png", 600, 256, "#ebebe9" ] } ] } [/block] 5. Now you need to configure you apps push systems. Depending on the operating systems that your app was built for [enter your FCM credentials](#section-entering-your-fcm-credentials-in-engagement-cloud) and/or [enter your APNS credentials](#section-entering-your-apns-credentials-in-engagement-cloud) and return back here after to complete the setup 6. Click **Save** 7. You will now have a value in the ['API space ID' field](doc:creating-a-push-notification-profile#section-finding-your-api-space-id), which you'll need to initialise an SDK, so note this down for the development team. [block:callout] { "type": "success", "title": "You now have configured your push notifications in Engagement Cloud", "body": "How return to the [setting up push notifications guide](doc:setting-up-push-notifications-new#section-embed-our-sdk-in-your-app) and move onto the next step." } [/block] ## Entering your FCM credentials in Engagement Cloud Our Android SDK uses [Firebase Cloud Messaging (FCM)](https://firebase.google.com/docs/cloud-messaging/) 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](https://console.firebase.google.com/u/0/?pli=1) 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** [block:image] { "images": [ { "image": [ "https://files.readme.io/c1a85db-Firebase_project_settings.jpg", "Firebase_project settings.jpg", 300, 142, "#e2e6e6" ] } ] } [/block] 2. In the **General **tab, copy your package name and paste it into the 'Name' field in Engagement Cloud [block:callout] { "type": "info", "title": "Don't see your package name?", "body": "If you don't see your package name in the **General** tab, you need to click **Add Firebase to your Android app**.\n\nComplete only steps 1 and 2 (register your app, and download your config file)." } [/block] 3. In the **Cloud Messaging** tab, copy your server key and paste it into the 'Server key' field in Engagement Cloud [block:image] { "images": [ { "image": [ "https://files.readme.io/d0423b4-Firebase_server_key.jpg", "Firebase_server key.jpg", 600, 196, "#eeeeee" ] } ] } [/block] ## 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 give us your APNS details. 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. 1. In your Apple Developer Portal, create a new certificate of type **Apple Push Notification Service SSL (Sandbox and Production)** and upload that certificate to the 'Private key' field on your Engagement Cloud profile page 2. In the 'Key ID' field in Engagement Cloud, enter the value of your [private key's ID](https://developer.apple.com/account/ios/authkey/) 3. In the 'Team ID' field in Engagement Cloud, enter the value of your [team ID](https://developer.apple.com/account/#/membership/) [block:image] { "images": [ { "image": [ "https://files.readme.io/5a640ab-Channel_management_push_notification_profile_-_APNS.png", "Channel management_push notification profile - APNS.png", 600, 210, "#eaeae9" ] } ] } [/block] ## 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: [block:image] { "images": [ { "image": [ "https://files.readme.io/d18fc17-Channel_management_push_notification_profile_-_API_space_ID.png", "Channel management_push notification profile - API space ID.png", 764, 158, "#e6e6e5" ] } ] } [/block]