Configure Apple Push Notification Service for iOS SDK

To be able to send Push notifications for iOS SDK using Marketing, you must obtain an Apple Push Notification service (APNs) authentication token signing key and configure the APNs integration in the Marketing web app.

📘

Refer to the Apple Push Notifications developer documentation for details.

Obtain an APNs key

1. In your Apple Developer account, navigate to Certificates, Identifiers & Profiles > Keys.
   

2. Add a new key and select APNs.
   

3. Confirm the creation of the key. Click Download to generate and download the key. Make note of the Team id (in the top right corner) and the Key Id.
   

❗️

Make sure to save the downloaded key in a secure place, as you cannot download this more than once.

Add APNs key to Marketing

1. Open the Marketing web application and navigate to Data & Assets > Integrations. Click + Add new integration.
   !Marketing Integrations - Add new integration

2. Locate Apple Push Notification Service and click + Add integration.
   !Marketing Integrations - Select Apple Push Notification Service integration

3. Read and accept the terms and conditions.
   !Marketing Integrations - Accept terms and conditions

4. Select an API mode (Development or Production) and enter the Team ID and Key ID. Open the key file you downloaded in a text editor and copy-paste its contents into the ES256 Private Key field. Enter your app's Bundle ID. Click Save integration to finish.
   !Marketing Integrations - Configure APNs integration

   ❗️

   API environment (Development or Production) cannot be changed later. You have to create a new integration in case you want to use a different environment. If you encounter BadDeviceToken errors, verify that you have selected the correct API environment.

   ❗️

   Only one APNs integration can be active at the same time in an Marketing project. If you'd like to use both the development and production APNs environments at the same time, you need two separate Marketing projects.

   ❗️

   Ensure the Application Bundle ID matches the Bundle Identifier in your application target in Xcode. If they don't match, push notification will fail to be delivered.

5. Navigate to Settings > Project settings > Channels > Push notifications > iOS Notification and set Apple Push Notification Service integration to Apple Push Notification Service.
   !Marketing - Select APNs integration