Push providers

A push provider is a configuration of a push API with one of four types: APN, Firebase, Huawei and Xiaomi. Chat supports all four provider types. Activity Feeds supports Firebase and APN.

Multiple providers can be added to the same Stream application to support:

• Different builds of the same application, such as prod and staging or regular and admin
• Different target platforms, such as starting with React Native and adapting native Android and iOS SDKs along the way
• Multi-tenant applications, where different customers need different configurations

While Stream doesn't have first class integration for push providers besides Firebase, APN, Huawei and Xiaomi, it is entirely possible to integrate with additional providers using webhooks.

Dashboard Configuration

1. Navigate to your Stream Dashboard
2. Select your application
3. Go to the Push Notifications section
4. Click New Configuration and select your provider
5. Upload your credentials

Firebase requires a service account key from your FCM project:

Firebase console → project settings (top left) → service accounts (4th sub header) → generate a new private key

Export your key and upload it in the Firebase credentials field. A sample service account JSON:

{
  "type": "service_account",
  "project_id": "your-project-id",
  "private_key_id": "key-id",
  "private_key": "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n",
  "client_email": "firebase-adminsdk-xxxxx@your-project.iam.gserviceaccount.com",
  "client_id": "client-id",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token"
}

APN requires an Apple Developer account and an authentication key or certificate:

Upsert a Push Provider

In the same endpoint, a new config can be created or updated.

const pushProviderConfig = {
  name: "my-custom-name",
  type: "firebase",
  firebase_credentials: "my-service-account-information",
};

client.upsertPushProvider(pushProviderConfig);

require 'getstream_ruby'
Models = GetStream::Generated::Models

client.common.upsert_push_provider(Models::UpsertPushProviderRequest.new(
  push_provider: Models::PushProvider.new(
    name: 'my-custom-name',
    type: 'firebase',
    firebase_credentials: 'my-service-account-information'
  )
))

client.UpsertPushProvider(ctx, &getstream.UpsertPushProviderRequest{
  PushProvider: &getstream.PushProviderRequest{
    Name:                "my-custom-name",
    Type:                getstream.PtrTo("firebase"),
    FirebaseCredentials: getstream.PtrTo("my-service-account-information"),
  },
})

List Push Providers

client.listPushProviders();

require 'getstream_ruby'

client.common.list_push_providers

client.ListPushProviders(ctx, &getstream.ListPushProvidersRequest{})

Delete a Push Provider

const pushProviderID = {
  type: "apn or firebase or huawei or xiaomi",
  name: "your given custom name while creating",
};

client.deletePushProvider(pushProviderID);

require 'getstream_ruby'

provider_type = 'apn or firebase or huawei or xiaomi'
provider_name = 'your given custom name while creating'

client.common.delete_push_provider(provider_type, provider_name)

pushProviderType := "apn or firebase or huawei or xiaomi"
pushProviderName := "your given custom name while creating"

client.DeletePushProvider(ctx, pushProviderType, pushProviderName, &getstream.DeletePushProviderRequest{})

Linking Devices to Providers

By default, adding a device doesn't require a push provider linking due to backward compatibility where old configurations don't have a name, so their names are empty.

• If the configuration name is not provided when adding a device, devices will be matched with configurations according to only their types.

• If the configuration name is provided, but invalid, the request will fail with a bad request error.

When devices are added, they can be linked to a provider to inherit their configuration.

const pushToken = "your client side generated device token to receive pushes";
const pushProviderType = "apn or firebase or huawei or xiaomi";
const userId = "your user id for server side calls";
const pushProviderName =
  "the name of the provider you created while configuring your app";

client.addDevice(pushToken, pushProviderType, userId, pushProviderName);

client.CreateDevice(ctx, &getstream.CreateDeviceRequest{
  ID:               "your client side generated device token to receive pushes",
  UserID:           getstream.PtrTo("your user id for server side calls"),
  PushProvider:     "apn or firebase or huawei or xiaomi",
  PushProviderName: getstream.PtrTo("the name of the provider you created while configuring your app"),
})

Single-Provider Configuration

If you're not interested in multi-bundle support, you can leverage the updateAppSettings endpoint to add push configuration for a single APN, Firebase, Huawei or Xiaomi provider.

// this configuration is same with upsert push provider
// except type is inherent and naming is missing so it's set to empty string
const firebase_config = {
  credentials_json: "my-service-account-information",
};

client.updateAppSettings({ firebase_config });

// this configuration is same with upsert push provider
// except type is inherent and naming is missing so it's set to empty string
client.UpdateApp(ctx, &getstream.UpdateAppRequest{
  FirebaseConfig: &getstream.FirebaseConfig{
    CredentialsJson: getstream.PtrTo("my-service-account-information"),
  },
})

Selecting a Configuration in the Feeds Client SDKs

When initializing the Activity Feeds SDK, specify which configuration to use:

let notificationsConfig = PushNotificationsConfig(
    pushProviderInfo: PushProviderInfo(
        name: "production-ios", // The name you gave in the dashboard
        pushProvider: .apn
    )
)

let config = FeedsConfig(pushNotificationsConfig: notificationsConfig)