Send push with Beamer through Courier

Prerequisites

A Beamer account
Your Beamer API key
A category in that template’s Beamer channel settings

Setup

Get your Beamer API key

In Beamer, open settings and copy your API key.

Configure in Courier

Open the in Courier, enter your API key, then click “Save.”

Profile requirements

Device tokens live on the user profile rather than on the send, so one profile can hold tokens for several devices and every push provider reads them from the same place. covers the model. No profile data is required for Beamer.

Overrides

covers the two levels and which one wins. lists the fields every push provider takes. Overrides change the request body Courier uses to send a push message. You can override these fields from Beamer’s postcreation object (documented in Beamer’s API docs).

{
  "filter": "",
  "filterUserId": "",
  "filterUrl": "",
  "sendPushNotification": "",
  "publish": ""
}

This override delivers a post to a specific known user id.

const { requestId } = await courier.send.message({
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {},
    providers: {
      beamer: {
        override: {
          body: {
            filterUserId: "user_123",
            sendPushNotification: "false",
            publish: "true",
          },
        },
      },
    },
  },
});

response = client.send.message(
    message={
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {},
        "providers": {
            "beamer": {
                "override": {
                    "body": {
                        "filterUserId": "user_123",
                        "sendPushNotification": "false",
                        "publish": "true",
                    },
                },
            },
        },
    },
)

curl -X POST https://api.courier.com/send \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
      "to": {},
      "providers": {
        "beamer": {
          "override": {
            "body": {
              "filterUserId": "user_123",
              "sendPushNotification": "false",
              "publish": "true"
            }
          }
        }
      }
    }
  }'

response = courier.send_.message(
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {},
    providers: {
      beamer: {
        override: {
          body: {
            filterUserId: "user_123",
            sendPushNotification: "false",
            publish: "true"
          }
        }
      }
    }
  }
)

response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
	Message: courier.SendMessageParamsMessage{
		To: courier.SendMessageParamsMessageToUnion{
			OfUserRecipient: &shared.UserRecipientParam{
			},
		},
		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
		Providers: shared.MessageProvidersParam{
			"beamer": shared.MessageProvidersTypeParam{
				Override: map[string]any{
					"body": map[string]any{
						"filterUserId": "user_123",
						"sendPushNotification": "false",
						"publish": "true",
					},
				},
			},
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .providers(MessageProviders.builder()
            .putAdditionalProperty("beamer", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                    "body", java.util.Map.of(
                        "filterUserId", "user_123",
                        "sendPushNotification", "false",
                        "publish", "true"
                    )
                ))))
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'to' => [],
    'providers' => [
      'beamer' => [
        'override' => [
          'body' => [
            'filterUserId' => 'user_123',
            'sendPushNotification' => 'false',
            'publish' => 'true',
          ],
        ],
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient {  },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Providers = new Dictionary<string, MessageProvidersType>()
        {
            {
                "beamer",
                new()
                {
                    Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                        """
                        {
                          "body": {
                            "filterUserId": "user_123",
                            "sendPushNotification": "false",
                            "publish": "true"
                          }
                        }
                        """
                    ),
                }
            },
        },
    },
};

var response = await client.Send.Message(parameters);

courier send message \
  --api-key "$COURIER_API_KEY" \
  --message.to '{}' \
  --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
  --message.providers '{"beamer": {"override": {"body": {"filterUserId": "user_123", "sendPushNotification": "false", "publish": "true"}}}}'

With Courier MCP, send my template to a known Beamer user id.

Provider details

beamer

Courier recommends routing to the channel. Naming this key in routing.channels instead is supported, and sends through just this provider.

Send to a specific provider

When that is worth doing, and what you give up: failover, channel priority, and providers you add later.

Get started

Available integrations

Send push with Beamer through Courier

Prerequisites

Setup

Profile requirements

Overrides

Provider details

Send to a specific provider

​Prerequisites

​Setup

​Profile requirements

​Overrides

​Provider details

Send to a specific provider

Prerequisites

Setup

Profile requirements

Overrides

Provider details