Skip to main content

​
Setup

You will need a Pusher account with a Channels app configured. In Courier, navigate to the Pusher Integration page, enter your app ID, key, secret, and cluster, then click “Save.”

​
Profile Requirements

To deliver a message to a recipient via Pusher, Courier must be provided a target object that contains the recipient’s Pusher channel. This value should be included in the recipient profile as pusher. 
{
  "message": {
    "to": {
      "pusher": {
        "channel": "my-channel"
      }
    }
  }
}

​
Template Requirements

Pusher can be used in Courier in two ways. One is via the “Push” channel; the other is via a direct Pusher channel. When in the direct Pusher channel, a jsonnet editor will be provided for you to customize your payload. When Pusher is integrated via the push channel, a rich editor will be shown.

​
Example Event

{
  "message": {
    "template": "NOTIFICATION_TEMPLATE_ID",
    "to": {
      "pusher": {
        "channel": "my-channel"
      }
    },
    "data": {
      "name": "Katherine Pryde"
    }
  }
}
Pusher uses the Pusher SDK directly and does not support the standard providers.<key>.override pattern used by other push providers.

​
Tracking Events

Courier will include tracking URL information in the data attribute on the incoming message payload. See Courier push notification tracking.