Skip to main content

​
Setup

You can get your OneSignal App ID and REST API Key by following these instructions. In Courier, navigate to the OneSignal Integration page, enter those values, then click “Save.”

​
Profile Requirements

To deliver a message to a recipient over OneSignal, Courier must be provided the recipient’s PlayerId or ExternalId. This ID should be included in the recipient profile as oneSignalPlayerID or oneSignalExternalUserId. 
{
  "message": {
    "to": {
       "oneSignalPlayerID": "..."
    }
  }
}
// or
{
  "message": {
    "to": {
       "oneSignalExternalUserId": "..."
    }
  }
}

​
Overrides

Overrides can be used to change the request body that Courier sends to OneSignal’s API. You can override any of the fields supported by OneSignal’s Create notification endpoint. 
{
  "message": {
    "template": "NOTIFICATION_TEMPLATE_ID",
    "to": {
      "oneSignalPlayerID": "player-id-123"
    },
    "providers": {
      "onesignal": {
        "override": {
          "body": {
            "priority": 10,
            "ttl": 3600,
            "small_icon": "ic_notification"
          }
        }
      }
    }
  }
}

​
Data Mapping

OneSignal imposes a limit to push notification payloads. When sending push notifications through automated workflows that include batching, data payloads can become too large, which will result in a failed send. Push channels can have data mapping enabled to customize which data you want passed down to the push channel provider. See Data Mapping for details.