Response Body Schema
enabledbooleanRequired
providerstringRequired
Value: native
typestringRequired
Value: push
created_atstring
Creation date in the ISO 8601 format according to universal time.
is_customboolean
Is connection using custom scripts
updated_atstring
Update date in the ISO 8601 format according to universal time.
settingsobjectRequired
settings. enabled_clientsarray<string>Required
settings. strategystringRequired
Push notification strategy
Available Values: code
prompt
Default Value: "code"
settings. apnsobjectRequired
Apple Push Notification Service configuration settings.
settings.apns. bundle_idstringRequired
This is the ID of your app. You can find it in the app info section of your Apple developer account.
settings.apns. keystringRequired
p8 of your Apple Developer account. To generate one follow these steps:
- Head over to Certificates, Identifiers & Profiles > Keys.
- Register a new key and give it a name.
- Enable the Apple Push Notifications service (APNs) checkbox by selecting it.
- Click the Continue button and on the next page, select Register.
- Download the .p8 key file.
settings.apns. key_idstringRequired
This is a 10-character unique identifier for the authentication key. You can find it in the key details section of the newly created key in your Apple developer account.
settings.apns. productionbooleanRequired
Default Value: true
settings.apns. team_idstringRequired
This is available in your Apple developer account.
settings. fcmobjectRequired
Firebase Cloud Messaging configuration settings. To enable the FCM integration, you need to get your service account key from the Firebase Console.
- Select your project, and click the gear icon on the top of the sidebar.
- After opening "Project Settings", head to the "Service Accounts" tab.
- Click "Generate new private key", then confirm by clicking "Generate key".
- Clicking "Generate key" downloads the generated service account json file.
settings.fcm. client_emailstringRequired
client_email
field located in your service account json
settings.fcm. private_keystringRequired
private_key
field located in your service account json
settings.fcm. project_idstringRequired
project_id
field located in your service account json