APNs Integration - Configuration Docs

To configure the APNs integration, you'll need:

Parameter	Type	Required(*)	Description
app_id	string	*	The default bundle identifier of the application that is configured with this project. It can be overriden on a per token basis, when registering device tokens.
badge	string	*
certificate	string	*	The APNs certificate in P8 format. Generate it at [developer.apple.com](https://developer.apple.com/account/resources/authkeys/add) with the 'Apple Push Notification service (APNs)' option selected.
key_id	string	*
team_id	string	*

Example

{
  "app_id": "com.example.myapp",
  "badge": "unread",
  "certificate": "-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgHnr4B2P+by++FGu/th0a44E8chJl5v5Vo4gq0YHw6e6gCgYIKoZIzj0DAQehRANCAARCg1MRibnfyeX5mx6+Rtfzzn7UhJP/oaqL4RzSmDuTsd3BTX33cuQ0gWHe20R2m1bLAkI1wrp+zbWOlAOAD7KX\n-----END PRIVATE KEY-----",
  "key_id": "ABCD1234EF",
  "team_id": "ABCD1234EF"
}

Configure via Dashboard

The easiest way to configure this integration is through the MagicBell dashboard:

Log in to your MagicBell dashboard.
Navigate to Settings > Integrations.
Find and click on this integration.
Follow the on-screen instructions to complete the configuration.

MagicBell Dashboard: Integration Configuration

Configure via API

You can also configure the integration using the API

Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "app_id": {
      "description": "The default bundle identifier of the application that is configured with this project. It can be overriden on a per token basis, when registering device tokens.",
      "pattern": "^[a-zA-Z0-9]+(.[a-zA-Z0-9]+)*$",
      "type": "string"
    },
    "badge": {
      "enum": [
        "unread",
        "unseen"
      ],
      "type": "string"
    },
    "certificate": {
      "description": "The APNs certificate in P8 format. Generate it at [developer.apple.com](https://developer.apple.com/account/resources/authkeys/add) with the 'Apple Push Notification service (APNs)' option selected.",
      "pattern": "^-+?\\s?BEGIN PRIVATE KEY-+\\n([A-Za-z0-9+/\\r\\n]+={0,2})\\n-+\\s?END PRIVATE KEY+-+\\n?$",
      "type": "string",
      "x-ui": {
        "tagName": "textarea"
      }
    },
    "key_id": {
      "maxLength": 10,
      "minLength": 10,
      "type": "string"
    },
    "payload_version": {
      "default": "2",
      "enum": [
        "1",
        "2"
      ],
      "type": "string",
      "x-ui": {
        "type": "hidden"
      }
    },
    "team_id": {
      "maxLength": 10,
      "minLength": 10,
      "type": "string"
    }
  },
  "required": [
    "app_id",
    "certificate",
    "key_id",
    "team_id",
    "badge"
  ],
  "type": "object"
}