/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Overview

    Copy link

    You can send push notification messages to your user's device when the device is either idle or running the client app in the background. For group channels, notifications can be configured to display an alert, play a sound, or place a badge on the client app's icon.

    Note: Starting June 20, 2024 the Legacy Firebase Cloud Messaging (FCM) API will be deprecated. To ensure uninterrupted push notification service, migrate to the new FCM HTTP v1 API as soon as possible. For instructions, refer to this FCM migration guide.


    Actions

    Copy link

    The following table shows a list of actions supported for your application. The API endpoints are relative to the base URL allocated to your Sendbird application. The base URL for the following endpoints are https://api-{application_id}.sendbird.com/v3.

    Note: To find the application ID and base URL of your application, sign in to Sendbird Dashboard, go to Settings > Application > General, and then check Application ID and API request URL.

    List of actions for managing push notifications

    Copy link
    ActionHTTP request

    Check push notifications

    GET /applications/push/settings
    Shows whether the push notifications feature is turned on for an application.

    Turn on push notifications

    PUT /applications/push/settings
    Determines whether to turn on the push notifications feature for an application.

    List push configurations

    GET /applications/push/{push_type}
    Retrieves a list of push configurations of an application.

    Get a push configuration

    GET /applications/push/{push_type}/{provider_id}
    Retrieves a specific push configuration of an application. The type of a push configuration is one of fcm, huawei, or apns.

    Remove a push configuration

    DELETE /applications/push/{push_type}/{provider_id}
    Cancels the registration of the push configuration of an application. The type of a push configuration is one of fcm, huawei, or apns.

    List push notification content templates

    GET /applications/push/message_templates
    Retrieves a list of push notification content templates of an application.

    Get a push notification content template

    GET /applications/push/message_templates/{template_name}
    Retrieves information on the specified push notification content template of an application.

    Update a push notification content template

    PUT /applications/push/message_templates/{template_name}
    Updates information on the specified push notification content template of an application.

    List auto event messages

    GET /applications/settings/auto_event_message
    Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use.

    Configure auto event message settings

    PUT /applications/settings/auto_event_message
    Determines whether to automatically send event messages to group channels when events take place in an application.

    List of actions for managing FCM configurations

    Copy link
    ActionHTTP request

    Add an FCM push configuration

    POST /applications/push/fcm
    Registers a FCM push configuration. To send push notifications to Android devices, you should first register the FCM push configuration.

    Update an FCM push configuration

    PUT /applications/push/fcm/{provider_id}
    Updates a specific FCM push configuration.

    List of actions for managing HMS configurations

    Copy link
    ActionHTTP request

    Add an HMS push configuration

    POST /applications/push/hms
    Registers an HMS push configuration. To send push notifications to Android devices for HMS, you should first register the HMS push configuration.

    Update an HMS push configuration

    PUT /applications/push/hms/{provider_id}
    Updates a specific HMS push configuration.

    List of actions for managing APNs configurations

    Copy link
    ActionHTTP request

    Add an APNs push configuration

    POST /applications/push/apns
    Registers an APNs push configuration. To send push notifications to iOS devices, you should first register the APNs push configuration.

    Update an APNs push configuration

    PUT /applications/push/apns/{provider_id}
    Updates a specific APNs push configuration.

    Delete an APNs certificate

    DELETE /applications/push/apns/cert/{provider_id}
    Deletes the APNs certificate.

    On this page