Push Payloads (Mobile SDKs)

Owned by Andrey Veprikov
Last updated: May 03, 2024
4 min read

Default Structure

It shows all available Payloads fields, but not all of them are used in every message type.

Android SDK / React Native SDK (Firebase)

{
  "title": "...",
  "body": "...",
  "icon": "...",
  "type": "...",
  "id": "...",
  "url": "...",
  "actions": "[{\"action\": "\b0\", \"title\": \"...\"}, ...]",
  "action_urls": "[...]",
  "image": "...",
  "event": "{\"type\": \"...\", \"uri\": \"...\"}"
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "...",
      "subtitle": "...",
      "body": "...",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "event": {
    "type": "...",
    "uri": "..."
  },
  "src": {
    "type": "...",
    "id": "..."
  }
}

Raw message

Android SDK / React Native SDK (Firebase)
{
  "title": "...",
  "body": "...",
  "type": "transactional",
  "id": "order_delivered",
  "event": "ADDITIONAL_CUSTOM_STRING"
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "...",
      "subtitle": "...",
      "body": "...",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "event": "ADDITIONAL_CUSTOM_STRING",
  "src": {
    "type": "transactional",
    "id": "order_delivered"
  }
}

Simple

Android SDK / React Native SDK (Firebase)

{
  "title": "Welcome aboard!",
  "body": "Hey, it's nice to know you're with us now. Check new updates in our application.",
  "type": "bulk",
  "id": "33631",
  "icon": "..."
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "Welcome aboard!",
      "subtitle": "Greeting message.",
      "body": "Hey, it's nice to know you're with us now. Check new updates in our application.",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "src": {
    "type": "bulk",
    "id": "33631"
  }
}

Open Web Link

Android SDK / React Native SDK (Firebase)
{
  "title": "Only today",
  "body": "This special offer for Dyson products only for you!",
  "type": "bulk",
  "id": "XFMjM4VAF4",
  "actions": "[{\"action\": "\b0\", \"title\": \"...\"}, ...]",
  "event": "{\"type\": \"web\", \"uri\": \"https://example.com/landing/promo\"}"
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "Only today",
      "subtitle": "Special Offer",
      "body": "This special offer for Dyson products only for you!",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "event": {
    "type": "web",
    "uri": "https://example.com/landing/promo"
  },
  "src": {
    "type": "bulk",
    "id": "XFMjM4VAF4"
  }
}

Open Category

Android SDK / React Native SDK (Firebase)
{
  "title": "Black Friday!",
  "body": "Check our big sale from this category",
  "type": "chain",
  "id": "72CONd54uF",
  "event": "{\"type\": \"category\", \"uri\": \"BFRIDAY_CATEGORY_ID\"}"
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "Black Friday!",
      "subtitle": "Discount",
      "body": "Check our big sale from this category",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "event": {
    "type": "category",
    "uri": "BFRIDAY_CATEGORY_ID"
  },
  "src": {
    "type": "chain",
    "id": "72CONd54uF"
  }
}

Open Product

Android SDK / React Native SDK (Firebase)
{
  "title": "...",
  "body": "...",
  "type": "chain",
  "id": "ugLxQ7KrnL",
  "event": "{\"type\": \"product\", \"uri\": \"PRODUCT_ID\"}"
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "...",
      "subtitle": "...",
      "body": "...",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "event": {
    "type": "product",
    "uri": "PRODUCT_ID"
  },
  "src": {
    "type": "chain",
    "id": "ugLxQ7KrnL"
  }
}

Custom

Android SDK / React Native SDK (Firebase)
{
  "title": "...",
  "body": "...",
  "type": "transactional",
  "id": "order_delivered",
  "event": "{\"type\": \"custom\", \"payload\": \"ADDITIONAL_JSON\"}"
}
iOS SDK / React Native SDK (iOS)
{
  "aps": {
    "alert": {
      "title": "...",
      "subtitle": "...",
      "body": "...",
      "badge": 1
    },
    "mutable-content": 1
  },
  "image_url": "...",
  "event": {
    "type": "custom",
    "payload": "ADDITIONAL_JSON"
  },
  "src": {
    "type": "transactional",
    "id": "order_delivered"
  }
}

Page Navigation



Related Pages

Copyright 2018-2024 PersonaClick