Push providers

Available providers

Apple APNs

Firebase FCM

Expo

OneSignal

Airship

Amazon SNS

Pusher Beams

Pusher

MagicBell

Pushbullet

Beamer

NowPush

Amazon SNS also sends . Apple APNs and Firebase FCM are the two the register device tokens for.

Can’t find a provider? Start a chat on the Courier site, or email support@courier.com

Channel overrides

covers the two levels and which one wins. These are the fields a push channel override accepts, whichever provider sends.

Field	Sets
`title`	The notification title
`body`	The notification body
`data`	Custom key-value data delivered alongside the notification
`icon`	The notification icon

const { requestId } = await courier.send.message({
  message: {
    to: { user_id: 'user_123' },
    template: 'nt_01kx4h2jdafq8bk9aftxak4b40',
    channels: {
      push: {
        override: {
          title: 'Order shipped',
          body: 'Your order is on its way.',
        },
      },
    },
  },
});

response = client.send.message(
    message={
        "to": {"user_id": "user_123"},
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "channels": {
            "push": {
                "override": {
                    "title": "Order shipped",
                    "body": "Your order is on its way.",
                },
            },
        },
    },
)

curl -X POST https://api.courier.com/send \
  -H "Authorization: Bearer $COURIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": {
      "to": { "user_id": "user_123" },
      "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
      "channels": {
        "push": {
          "override": {
            "title": "Order shipped",
            "body": "Your order is on its way."
          }
        }
      }
    }
  }'

response = courier.send_.message(
  message: {
    to: { user_id: "user_123" },
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    channels: {
      push: {
        override: {
          title: "Order shipped",
          body: "Your order is on its way."
        }
      }
    }
  }
)

response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
	Message: courier.SendMessageParamsMessage{
		To: courier.SendMessageParamsMessageToUnion{
			OfUserRecipient: &shared.UserRecipientParam{
				UserID: courier.String("user_123"),
			},
		},
		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
		Channels: shared.MessageChannelsParam{
			"push": shared.ChannelParam{
				Override: map[string]any{
					"title":       "Order shipped",
					"body":        "Your order is on its way.",
				},
			},
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().userId("user_123").build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .channels(MessageChannels.builder()
            .putAdditionalProperty("push", JsonValue.from(java.util.Map.of(
                "override", java.util.Map.of(
                    "title", "Order shipped",
                    "body", "Your order is on its way."))))
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'to' => ['userID' => 'user_123'],
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'channels' => [
      'push' => [
        'override' => [
          'title' => 'Order shipped',
          'body' => 'Your order is on its way.',
        ],
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient { UserID = "user_123" },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Channels = new Dictionary<string, Channel>()
        {
            {
                "push",
                new()
                {
                    Override = new Dictionary<string, JsonElement>()
                    {
                        { "title", JsonSerializer.SerializeToElement("Order shipped") },
                        { "body", JsonSerializer.SerializeToElement("Your order is on its way.") },
                    },
                }
            },
        },
    },
};

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

courier send message \
  --api-key "$COURIER_API_KEY" \
  --message.to '{"user_id": "user_123"}' \
  --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
  --message.channels '{"push":{"override":{"title":"Order shipped","body":"Your order is on its way."}}}'

With Courier MCP, send my nt_01kx4h2jdafq8bk9aftxak4b40 template to user_123 and override the push title to "Order shipped".

Tracking

Courier attaches a trackingUrl to every push request. Posting to it updates the notification’s state. The do this for you. To do it manually:

Example message

{
  "message": {
    "data": {
      "trackingUrl": "https://api.courier.com/e/123_channelTrackingId"
      // other data attributes
    }
    // other messages attributes
  }
}

Example request

await fetch("https://api.courier.com/e/123_channelTrackingId", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ event: "DELIVERED" }),
});

import requests

requests.post(
    "https://api.courier.com/e/123_channelTrackingId",
    json={"event": "DELIVERED"},
)

curl -X POST https://api.courier.com/e/123_channelTrackingId \
  -H "Content-Type: application/json" \
  -d '{"event":"DELIVERED"}'

event is DELIVERED or CLICKED.

Provider-specific tracking

Each provider puts the trackingUrl somewhere different in the payload your app receives:

Provider	Where to read it
	`data` on the incoming `payload`
	`data` on the incoming `message` payload
	`data` on the incoming payload
	`data` on the incoming payload
	`global_attributes` data bag

Targeting specific devices

If a user has tokens from more than one app, target a subset at send time. Use it for per-platform notifications, or when several apps share one provider project. The already tag every token they register with the app’s own identifier, the bundle id on iOS and the package name on Android. Nothing to set up, so the only thing you write is the filter.

Filter tokens at send time

Pass filterByBundleId and bundleId in the provider override to send only to tokens whose device.app_id matches:

const { requestId } = await courier.send.message({
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      user_id: "user_123",
    },
    routing: {
      method: "single",
      channels: [
        "push",
      ],
    },
    providers: {
      "firebase-fcm": {
        override: {
          config: {
            filterByBundleId: true,
            bundleId: "com.acme-corp.app",
          },
        },
      },
    },
  },
});

response = client.send.message(
    message={
        "template": "nt_01kx4h2jdafq8bk9aftxak4b40",
        "to": {
            "user_id": "user_123",
        },
        "routing": {
            "method": "single",
            "channels": [
                "push",
            ],
        },
        "providers": {
            "firebase-fcm": {
                "override": {
                    "config": {
                        "filterByBundleId": True,
                        "bundleId": "com.acme-corp.app",
                    },
                },
            },
        },
    },
)

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": {
        "user_id": "user_123"
      },
      "routing": {
        "method": "single",
        "channels": [
          "push"
        ]
      },
      "providers": {
        "firebase-fcm": {
          "override": {
            "config": {
              "filterByBundleId": true,
              "bundleId": "com.acme-corp.app"
            }
          }
        }
      }
    }
  }'

response = courier.send_.message(
  message: {
    template: "nt_01kx4h2jdafq8bk9aftxak4b40",
    to: {
      user_id: "user_123"
    },
    routing: {
      method: "single",
      channels: [
        "push"
      ]
    },
    providers: {
      "firebase-fcm": {
        override: {
          config: {
            filterByBundleId: true,
            bundleId: "com.acme-corp.app"
          }
        }
      }
    }
  }
)

response, err := client.Send.Message(context.TODO(), courier.SendMessageParams{
	Message: courier.SendMessageParamsMessage{
		To: courier.SendMessageParamsMessageToUnion{
			OfUserRecipient: &shared.UserRecipientParam{
				UserID: courier.String("user_123"),
			},
		},
		Template: courier.String("nt_01kx4h2jdafq8bk9aftxak4b40"),
		Routing: courier.SendMessageParamsMessageRouting{
			Channels: []shared.MessageRoutingChannelUnionParam{
				{OfString: courier.String("push")},
			},
			Method: "single",
		},
		Providers: shared.MessageProvidersParam{
			"firebase-fcm": shared.MessageProvidersTypeParam{
				Override: map[string]any{
					"config": map[string]any{
						"filterByBundleId": true,
						"bundleId": "com.acme-corp.app",
					},
				},
			},
		},
	},
})

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().userId("user_123").build())
        .template("nt_01kx4h2jdafq8bk9aftxak4b40")
        .routing(SendMessageParams.Message.Routing.builder()
            .addChannel("push")
            .method(SendMessageParams.Message.Routing.Method.SINGLE)
            .build())
        .providers(MessageProviders.builder()
            .putAdditionalProperty("firebase-fcm", JsonValue.from(java.util.Map.of("override", java.util.Map.of(
                    "config", java.util.Map.of(
                        "filterByBundleId", true,
                        "bundleId", "com.acme-corp.app"
                    )
                ))))
            .build())
        .build())
    .build();
SendMessageResponse response = client.send().message(params);

$response = $client->send->message(
  message: [
    'template' => 'nt_01kx4h2jdafq8bk9aftxak4b40',
    'to' => [
      'user_id' => 'user_123',
    ],
    'routing' => [
      'method' => 'single',
      'channels' => [
        'push',
      ],
    ],
    'providers' => [
      'firebase-fcm' => [
        'override' => [
          'config' => [
            'filterByBundleId' => true,
            'bundleId' => 'com.acme-corp.app',
          ],
        ],
      ],
    ],
  ],
);

SendMessageParams parameters = new()
{
    Message = new()
    {
        To = new UserRecipient { UserID = "user_123" },
        Template = "nt_01kx4h2jdafq8bk9aftxak4b40",
        Routing = new() { Channels = ["push"], Method = Send::Method.Single },
        Providers = new Dictionary<string, MessageProvidersType>()
        {
            {
                "firebase-fcm",
                new()
                {
                    Override = JsonSerializer.Deserialize<Dictionary<string, JsonElement>>(
                        """
                        {
                          "config": {
                            "filterByBundleId": true,
                            "bundleId": "com.acme-corp.app"
                          }
                        }
                        """
                    ),
                }
            },
        },
    },
};

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

courier send message \
  --api-key "$COURIER_API_KEY" \
  --message.to '{"user_id": "user_123"}' \
  --message.template nt_01kx4h2jdafq8bk9aftxak4b40 \
  --message.routing '{"method": "single", "channels": ["push"]}' \
  --message.providers '{"firebase-fcm": {"override": {"config": {"filterByBundleId": true, "bundleId": "com.acme-corp.app"}}}}'

With Courier MCP, send my template to user_123, only to tokens from my desktop app bundle.

Use the bundle id of the app whose devices you want, com.acme-corp.app above. If bundleId matches none of the user’s tokens, the message is not delivered to that provider. The same override structure works for any push provider:

Provider	Override path
Firebase Cloud Messaging	`providers.firebase-fcm.override.config`
Apple Push Notification service	`providers.apn.override.config`
Expo	`providers.expo.override.config`
OneSignal	`providers.onesignal.override.config`

Filtering reads the tokens Courier manages, whether an SDK registered them or your backend did. A token passed inline in to, such as firebaseToken or apn.token, carries no device record and bypasses the filter.

Registering tokens from your backend rather than through an SDK? Set device.app_id yourself on the write. has that call.

Custom data not reaching the device? data maps into the push payload by default. covers the v1 template setting that can stop it.

Get started

Available integrations

Available providers

Apple APNs

Firebase FCM

Expo

OneSignal

Airship

Amazon SNS

Pusher Beams

Pusher

MagicBell

Pushbullet

Beamer

NowPush

Channel overrides

Tracking

Example message

Example request

Provider-specific tracking

Targeting specific devices

Filter tokens at send time

​Available providers

Apple APNs

Firebase FCM

Expo

OneSignal

Airship

Amazon SNS

Pusher Beams

Pusher

MagicBell

Pushbullet

Beamer

NowPush

​Channel overrides

​Tracking

​Example message

​Example request

​Provider-specific tracking

​Targeting specific devices

​Filter tokens at send time

Available providers

Channel overrides

Tracking

Example message

Example request

Provider-specific tracking

Targeting specific devices

Filter tokens at send time