Skip to main content

Setup

You will need a Beamer account. In Courier, navigate to the Beamer Integration page, enter your API key, then click “Save.”

Profile Requirements

No profile data is required for Beamer.

Overrides

Overrides can be used to change the request body that Courier uses to send a push message. You can override the following fields from Beamer’s postcreation object (documented here in Beamer’s API docs).
{
  "filter": "",
  "filterUserId": "",
  "filterUrl": "",
  "sendPushNotification": "",
  "publish": ""
}
Below is an example of using the override to deliver a post to a specific known user id.
{
  "message": {
    "template": "NOTIFICATION_TEMPLATE_ID",
    "to": {},
    "providers": {
      "beamer": {
        "override": {
          "body": {
            "filterUserId": "user-123",
            "sendPushNotification": "false",
            "publish": "true"
          }
        }
      }
    }
  }
}