# Push Notifications

This page describes the payload for notifications from Pinch.

WARNING

Make sure to set the messagingId according to the usage documentation for your platform.

# Default Payload Template

{
  "message":{
    "token":"@@PINCH_MESSAGINGID@@",
    "notification":{
      "body":"@@PINCH_TITLE@@",
      "title":"@@PINCH_BODY@@"
    },
    "apns":{
      "payload":{
        "aps":{
          "apns-priority":"10",
          "content-available":1
        }
      }
    },
    "android":{
      "ttl":"@@PINCH_EXPIRATION_SECONDS@@s",
      "priority":"high"
    },
    "data":{
      "type":"pinch",
      "title":"@@PINCH_TITLE@@",
      "body":"@@PINCH_BODY@@",
      "url":"@@PINCH_URL@@",
      "expireTime":"@@PINCH_EXPIRETIME@@",
      "deliveryId":"@@PINCH_DELIVERYID@@"
    }
  }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# Customized Payload Template

The notification payload from Pinch can be customized to your liking. The following variables can be placed anywhere in your own custom payload template:

  • @@PINCH_URL@@ - URL to campaign
  • @@PINCH_DELIVERYID@@ - Unique identifier for push delivery
  • @@PINCH_MESSAGINGID@@ - Push token / Device identifier
  • @@PINCH_EXPIRATION_SECONDS@@ - Notification expiration in seconds
  • @@PINCH_EXPIRETIME@@ - Notification expiration in epoch millis
  • @@PINCH_TITLE@@ - Notification title
  • @@PINCH_BODY@@ - Notification body