Application Object

The Application object defines a mobile or web application authorized to send push notifications to associated devices. It stores authentication credentials and configuration details required to interact with Apple and Google push services.

Each application is uniquely identified by an application_sid and is linked to a specific partner (partner_sid). Depending on the mobile platform, the object may include:

• Apple Push Notification Service (APNs) parameters such as apns_id, apns_team_id, apns_p8, or a Base64-encoded .p12 certificate and its expiration date.
• Google Firebase configuration stored as Base64-encoded google_credentials JSON.

Together, these settings enable the CarrierX platform to securely route push messages from a partner's backend to registered mobile devices.

Application Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
apns_id createupdate	string	The Apple Push Messaging Application ID.
apns_key_id createupdate	string	The key identifier of the Apple token-based authentication key.
apns_p8 createupdate	string	The authentication token signing key, the content of a .p8 file with line breaks converted to \n.
apns_p12 createupdate	string	The Apple Push Notification P12 certificate, encoded to Base64.
apns_p12_expiration read only	string	The expiration date and time for the Apple Push Notification P12 certificate.
apns_p12_password createupdate	string	The passphrase of the Apple Push Notification P12 certificate.
apns_team_id createupdate	string	The team identifier of your team in Apple Developer account.
apns_topic createupdate	string	The default Apple Push Notification topic for the application.
application_sid read only	string	The application secure ID.
google_credentials createupdate	string	The Google Auth Credentials JSON file, encoded to Base64 format. Refer to Google Firebase documentation for information on how to generate such JSON credentials file.
name createupdate	string	The name of the application.
partner read only	object	The Partner object associated with the application. This field is displayed if with_related is set to true when performing the GET queries.
partner_sid read only	string	The secure ID of the partner associated with the application.

Sample Application Object

{
    "apns_id": "",
    "apns_key_id": null,
    "apns_p8": null,
    "apns_p12": "MIINlwIBAzCCDV4...MYzDtWcmbI2AgEB",
    "apns_p12_expiration": "2024-08-19T16:03:25.000Z",
    "apns_p12_password": "myStrongPassword",
    "apns_team_id": null,
    "apns_topic": null,
    "application_sid": "8b03edc1-5378-4c4e-a480-9015206089dc",
    "google_credentials": "L2hvbWUvdXNlci9Eb3dubG9hZHMvc2VydmljZS1hY2NvdW50LWZpbGUuanNvbgo=",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"
}