Skip to main content

Setup

You will need a OneSignal account. Get your App ID and REST API Key by following these instructions. In Courier, navigate to the OneSignal Email Integration page, enter both values, then click “Save.”

Profile Requirements

To deliver a message to a recipient over OneSignal Email, Courier must be provided the recipient’s email address. This value should be included in the recipient profile as email.
{
  "message": {
    "to": {
      "email": "alice@acme.com"
    }
  }
}
The oneSignalPlayerID and oneSignalExternalUserId profile fields are used by the OneSignal push provider, not the OneSignal Email provider.

Overrides

OneSignal Email does not support provider-level overrides or attachments.