50

Test your push implementation

After you set up push notifications, you should send some test messages. You can send messages through the Customer.io push composer. If your app is set up to send more than the standard title, body, image, and link, you’ll need to send a custom payload.

The payloads below represent what your app can expect to receive from Customer.io. If you use a custom payload, you’ll need to use the format(s) below to make sure that the SDK receives your message properly.

When testing, you should:

• Set the link to the deep link URL that you want to open when your tester taps your notification.
• Set the image to the URL of an image you want to show in your notification. It’s important that the image URL starts with https:// and not http:// or the image might not show up.
  APNS payload

  {
      "aps": {
          // basic iOS message and options go here
          "mutable-content": 1,
          "sound": "default",
          "alert": {
              "title": "string", //(optional) The title of the notification.
              "body": "string" //(optional) The message you want to send.
          }
      },
      "CIO": {
          "push": {
              "link": "string", //generally a deep link, i.e. my-app:://...
              "image": "string" //HTTPS URL of your image, including file extension
          }
      }
  }
  

  • CIO object

    Contains options supported by the Customer.io SDK.
    • push object

      Required Describes push notification options supported by the CIO SDK.
      • image string

        The URL of an HTTPS image that you want to use for your message.
      • link string

        A deep link (to a page in your app), or a link to a web page.
  • aps object

    A push payload intended for an iOS device.
    • alert
      string

      A simple alert message.
      • body string

        The body of your push notification.
      • launch-image string

        The name of the launch image file you want to display. When a user launches your app, they’ll see this image or storyboard file rather than your app’s normal launch image.
      • loc-args array of [ strings ]
        An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.
      • loc-key string

        The key for a localized message string in your app’s Localizable.strings file.
      • subtitle string

        Additional information that explains the purpose of the notification.
      • subtitle-loc-args array of [ strings ]
        An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.
      • subtitle-loc-key string

        The key for a localized subtitle string in your app’s Localizable.strings file.
      • title string

        The title of your push notification.
      • title-loc-args array of [ strings ]
        An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.
      • title-loc-key string

        The key for a localized title string in your app’s Localizable.strings files.
    • badge integer

      The number you want to display on your app’s icon. Set to 0 to remove the current badge, if any.
    • category string

      The notification’s type. This string must correspond to the identifier of one of the UNNotificationCategory objects you register at launch time.
    • content-available integer

      The background notification flag. Use 1 without an alert to perform a silent update. 0 indicates a normal push notification.
    • interruption-level string

      Indicates the importance and delivery timing of a notification.

      Accepted values:passive,active,time-sensitive,critical

    • mutable-content integer

      If you use the Customer.io SDK, you must set this value to 1 to support images and “delivered” metrics from your push notifications. When the value is 1, your notification is passed to your notification service app extension before delivery. Use your extension to modify the notification’s content.
    • relevance-score number

      A number between 0 and 1. The highest score is considered the “most relevant” and is featured in the notification summary.
    • sound
      string

      The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you’ll pass an object instead.
      • critical integer

        1 indicates critical. 0 is not critical.
      • name string

        The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound.
      • volume number

        The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume.
    • target-content-id string

      The identifier of the window brought forward.
    • thread-id string

      An identifier to group related notifications.

  FCM payload

  {
    "message": {
      "apns": {
        "payload": {
          "aps": {
            // basic iOS message and options go here
            "mutable-content": 1,
            "sound": "default",
            "alert": {
              "title": "string", //(optional) The title of the notification.
              "body": "string" //(optional) The message you want to send.
             }
          },
          "CIO": {
            "push": {
              "link": "string", //generally a deep link, i.e. my-app://... or https://yourwebsite.com/...
              "image": "string" //HTTPS URL of your image, including file extension
            }
          }
        },
        "headers": {
          // (optional) headers to send to the Apple Push Notification Service.
          "apns-priority": 10
        }
      } 
    }
  }
  

  • message object

    Required The base object for all FCM payloads.
    • apns object

      Required Defines a payload for iOS devices sent through Firebase Cloud Messaging (FCM).
      • headers object

        Headers defined by Apple’s payload reference that you want to pass through FCM.
      • payload object

        Required Contains a push payload.
        • CIO object

          Contains properties interpreted by the Customer.io iOS SDK.
          • push object

            Required A push payload for the iOS SDK.
            • body string

              The body of your push notification.
            • image string

              The URL of an HTTPS image that you want to use for your message.
            • link string

              A deep link (to a page in your app), or a link to a web page.
            • title string

              The title of your push notification.
        • aps object

          A push payload intended for an iOS device.
          • alert
            string

            A simple alert message.
            • body string

              The body of your push notification.
            • launch-image string

              The name of the launch image file you want to display. When a user launches your app, they’ll see this image or storyboard file rather than your app’s normal launch image.
            • loc-args array of [ strings ]
              An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.
            • loc-key string

              The key for a localized message string in your app’s Localizable.strings file.
            • subtitle string

              Additional information that explains the purpose of the notification.
            • subtitle-loc-args array of [ strings ]
              An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.
            • subtitle-loc-key string

              The key for a localized subtitle string in your app’s Localizable.strings file.
            • title string

              The title of your push notification.
            • title-loc-args array of [ strings ]
              An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.
            • title-loc-key string

              The key for a localized title string in your app’s Localizable.strings files.
          • badge integer

            The number you want to display on your app’s icon. Set to 0 to remove the current badge, if any.
          • category string

            The notification’s type. This string must correspond to the identifier of one of the UNNotificationCategory objects you register at launch time.
          • content-available integer

            The background notification flag. Use 1 without an alert to perform a silent update. 0 indicates a normal push notification.
          • interruption-level string

            Indicates the importance and delivery timing of a notification.

            Accepted values:passive,active,time-sensitive,critical

          • mutable-content integer

            If you use the Customer.io SDK, you must set this value to 1 to support images and “delivered” metrics from your push notifications. When the value is 1, your notification is passed to your notification service app extension before delivery. Use your extension to modify the notification’s content.
          • relevance-score number

            A number between 0 and 1. The highest score is considered the “most relevant” and is featured in the notification summary.
          • sound
            string

            The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you’ll pass an object instead.
            • critical integer

              1 indicates critical. 0 is not critical.
            • name string

              The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound.
            • volume number

              The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume.
          • target-content-id string

            The identifier of the window brought forward.
          • thread-id string

            An identifier to group related notifications.
        • Custom key-value pairs* any type

          Additional properties that you've set up your app to interpret outside of the Customer.io SDK.