Notifications

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

Schedule notifications that the host platform shows after the player leaves the game. Use them to bring players back: a daily energy refill, an expiring bonus, "your building is ready".

Notifications are delivered by the host platform, not by the game. Support is platform-specific — currently only MSN shows them. Everywhere else isSupported is false and the methods reject, so always gate your UI on isSupported.

Implementation order

Required — Map every notification id to its platform value in the config under notifications.
Recommended — Check isSupported before showing any notification-related UI.
Recommended — schedule() a re-engagement notification at a natural moment (level completed, energy spent, session about to end).
Recommended — On launch, read platform.payload to find out whether the game was opened from a notification, and route the player accordingly.

Configuration

The game always works with its own notification id. Platforms that need their own identifier get it from the notifications section of the config:

{
    "notifications": [
        {
            "id": "come_back",  // the id you pass to schedule() / cancel()
            "msn": 1            // MSN notification type — an integer from 0 to 15
        },
        {
            "id": "energy_full",
            "msn": 2
        }
    ]
}

On MSN a notification without an integer type in the config is rejected — the platform identifies notifications by type, not by name.

Automatic re-engagement notifications

On MSN, Bridge schedules three re-engagement notifications right after initialization — shown no earlier than 1 day, 3 days, and 7 days after the session. They require no code and occupy MSN types 8, 9, and 10, which is why those types are rejected for your own notifications.

To replace them with your own, turn them off in the config:

{
    "platforms": {
        "msn": {
            "disableAutoNotifications": true
        }
    }
}

Is Supported

Check support before showing notification-related UI (an opt-in toggle, a "remind me" button).

bridge.notifications.isSupported

Bridge.notifications.isSupported

Use the Is Notifications Supported condition.

Bridge.notifications.is_supported

playgama_bridge_notifications_is_supported()

bridge.notifications.is_supported()

bridge.notifications.isSupported

Platform support · 1 of 25 platforms

Supports: msn

Does not support: crazy_games, discord, dlightek, facebook, game_distribution, gamepush, gamesnacks, huawei, jio_games, lagged, microsoft_store, ok, playgama, poki, portal, reddit, samsung, telegram, tiktok, vk, xiaomi, y8, yandex, youtube

Schedule

Schedules a notification. The platform shows it after the player has left the game, no earlier than delaySeconds from now.

bridge.notifications.schedule({
    id: 'come_back',
    title: 'Ready for another round?',
    description: 'Jump back in right where you left off.',
    delaySeconds: 86400,
    payload: 'come_back'
})
    .then(() => {
        // scheduled
    })
    .catch(error => {
        // error
    })

using Playgama;
using Playgama.Modules.Notifications;

private void ScheduleComeBackNotification()
{
    var notification = new ScheduledNotification
    {
        id = "come_back",
        title = "Ready for another round?",
        description = "Jump back in right where you left off.",
        delaySeconds = 86400,
        payload = "come_back"
    };

    Bridge.notifications.Schedule(notification, success =>
    {
        Debug.Log($"Notification scheduled: {success}");
    });
}

Build the notification with the common Add Action Parameter actions (id, title, description, delaySeconds, image, callToAction, payload), then run Notifications Schedule and handle the On Notifications Schedule Completed trigger.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"add-action-parameter","objectClass":"PlaygamaBridge","parameters":{"key":"\"id\"","value":"\"come_back\""}},{"id":"add-action-parameter","objectClass":"PlaygamaBridge","parameters":{"key":"\"title\"","value":"\"Ready for another round?\""}},{"id":"add-action-parameter","objectClass":"PlaygamaBridge","parameters":{"key":"\"description\"","value":"\"Jump back in right where you left off.\""}},{"id":"add-action-parameter","objectClass":"PlaygamaBridge","parameters":{"key":"\"delaySeconds\"","value":"86400"}},{"id":"add-action-parameter","objectClass":"PlaygamaBridge","parameters":{"key":"\"payload\"","value":"\"come_back\""}},{"id":"notifications-schedule","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-notifications-schedule-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"is-last-action-completed-successfully","objectClass":"PlaygamaBridge"}],"actions":[{"type":"comment","text":"scheduled"}]}]}]}

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::AddActionParameter"},"parameters":["","\"id\"","\"come_back\"",""]},{"type":{"value":"PlaygamaBridge::AddActionParameter"},"parameters":["","\"title\"","\"Ready for another round?\"",""]},{"type":{"value":"PlaygamaBridge::AddActionParameter"},"parameters":["","\"description\"","\"Jump back in right where you left off.\"",""]},{"type":{"value":"PlaygamaBridge::AddActionParameter"},"parameters":["","\"delaySeconds\"","\"86400\"",""]},{"type":{"value":"PlaygamaBridge::AddActionParameter"},"parameters":["","\"payload\"","\"come_back\"",""]},{"type":{"value":"PlaygamaBridge::NotificationsSchedule"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnNotificationsScheduleCompleted"},"parameters":["",""]}],"actions":[],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsLastActionCompletedSuccessfully"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"scheduled\"","\"info\"",""]}]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

Bridge.notifications.schedule({
    "id": "come_back",
    "title": "Ready for another round?",
    "description": "Jump back in right where you left off.",
    "delaySeconds": 86400,
    "payload": "come_back"
}, funcref(self, "_on_schedule_completed"))

func _on_schedule_completed(success):
    print("Notification scheduled: ", success)

Bridge.notifications.schedule({
    "id": "come_back",
    "title": "Ready for another round?",
    "description": "Jump back in right where you left off.",
    "delaySeconds": 86400,
    "payload": "come_back"
}, Callable(self, "_on_schedule_completed"))

func _on_schedule_completed(success):
    print("Notification scheduled: ", success)

var notification = {
    id: "come_back",
    title: "Ready for another round?",
    description: "Jump back in right where you left off.",
    delaySeconds: 86400,
    payload: "come_back"
}
playgama_bridge_notifications_schedule(json_stringify(notification))

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_notifications_schedule_callback" {
    if async_load[? "success"] {
        // notification scheduled
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.notifications.schedule(
        {
            id = "come_back",
            title = "Ready for another round?",
            description = "Jump back in right where you left off.",
            delaySeconds = 86400,
            payload = "come_back"
        },
        function ()
            -- scheduled
        end,
        function ()
            -- error
        end
    )
end

bridge.notifications.schedule({
    id: 'come_back',
    title: 'Ready for another round?',
    description: 'Jump back in right where you left off.',
    delaySeconds: 86400,
    payload: 'come_back'
})
    .then(() => {
        // scheduled
    })
    .catch(error => {
        // error
    })

Notification fields

Field

Type

Required

Description

id

string

yes

Game-level id, mapped to the platform value in the config.

title

string

yes

Notification headline. MSN: up to 60 characters.

description

string

yes

Notification body. MSN: up to 200 characters.

delaySeconds

integer

Minimum delay before the notification may be shown. MSN: up to 604800 (7 days).

image

string

Image for the notification. MSN expects base64 image data.

callToAction

string

Label of the notification button.

payload

string

Arbitrary string returned through platform.payload when the game is launched from this notification.

Cancel

Cancels a previously scheduled notification by its game-level id.

No platform supports cancellation yet — the call rejects on every platform, MSN included. Schedule notifications you are sure about, and use payload to detect and skip an outdated one at launch.

bridge.notifications.cancel('come_back')
    .then(() => {
        // canceled
    })
    .catch(error => {
        // error
    })

Bridge.notifications.Cancel("come_back", success =>
{
    Debug.Log($"Notification canceled: {success}");
});

Call the Notifications Cancel action with the notification id, then handle the On Notifications Cancel Completed trigger.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"notifications-cancel","objectClass":"PlaygamaBridge","parameters":{"id":"\"come_back\""}}]},{"eventType":"block","conditions":[{"id":"on-notifications-cancel-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"is-last-action-completed-successfully","objectClass":"PlaygamaBridge"}],"actions":[{"type":"comment","text":"canceled"}]}]}]}

Call the Notifications Cancel action with the notification id, then handle the On Notifications Cancel Completed condition.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::NotificationsCancel"},"parameters":["","\"come_back\"",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnNotificationsCancelCompleted"},"parameters":["",""]}],"actions":[],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsLastActionCompletedSuccessfully"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"canceled\"","\"info\"",""]}]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

Bridge.notifications.cancel("come_back", funcref(self, "_on_cancel_completed"))

func _on_cancel_completed(success):
    print("Notification canceled: ", success)

Bridge.notifications.cancel("come_back", Callable(self, "_on_cancel_completed"))

func _on_cancel_completed(success):
    print("Notification canceled: ", success)

playgama_bridge_notifications_cancel("come_back")

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_notifications_cancel_callback" {
    if async_load[? "success"] {
        // notification canceled
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.notifications.cancel(
        "come_back",
        function ()
            -- canceled
        end,
        function ()
            -- error
        end
    )
end

bridge.notifications.cancel('come_back')
    .then(() => {
        // canceled
    })
    .catch(error => {
        // error
    })

Cancel All

Cancels every notification scheduled by the game. Same platform limitation as Cancel.

bridge.notifications.cancelAll()
    .then(() => {
        // canceled
    })
    .catch(error => {
        // error
    })

Bridge.notifications.CancelAll(success =>
{
    Debug.Log($"All notifications canceled: {success}");
});

Call the Notifications Cancel All action, then handle the On Notifications Cancel All Completed trigger.

Call the Notifications Cancel All action, then handle the On Notifications Cancel All Completed condition.

Bridge.notifications.cancel_all(funcref(self, "_on_cancel_all_completed"))

func _on_cancel_all_completed(success):
    print("All notifications canceled: ", success)

Bridge.notifications.cancel_all(Callable(self, "_on_cancel_all_completed"))

func _on_cancel_all_completed(success):
    print("All notifications canceled: ", success)

playgama_bridge_notifications_cancel_all()

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_notifications_cancel_all_callback" {
    if async_load[? "success"] {
        // all notifications canceled
    }
}

local bridge = require("bridge.bridge")

function init(self)
    bridge.notifications.cancel_all(
        function ()
            -- canceled
        end,
        function ()
            -- error
        end
    )
end

bridge.notifications.cancelAll()
    .then(() => {
        // canceled
    })
    .catch(error => {
        // error
    })

Handling the launch payload

When the player opens the game from a notification, the notification's payload arrives as the regular platform payload. There is no separate notifications API for it — read platform.payload after initialization.

if (bridge.platform.payload === 'come_back') {
    // the player came back from the notification — show the returning-player bonus
}

if (Bridge.platform.payload == "come_back")
{
    // the player came back from the notification
}

On System → On start of layout, compare the PlaygamaBridge.PlatformPayload expression with the payload you scheduled.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-start-of-layout","objectClass":"System"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"compare-two-values","objectClass":"System","parameters":{"first-value":"PlaygamaBridge.PlatformPayload","comparison":0,"second-value":"\"come_back\""}}],"actions":[{"type":"comment","text":"the player came back from the notification"}]}]}]}

Once Is Initialized is true, compare the PlaygamaBridge::PlatformPayload() expression with the payload you scheduled.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsInitialized"},"parameters":["",""]},{"type":{"value":"BuiltinCommonInstructions::CompareStrings"},"parameters":["PlaygamaBridge::PlatformPayload()","=","\"come_back\""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"the player came back from the notification\"","\"info\"",""]}]}],"eventsCount":1,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

if Bridge.platform.payload == "come_back":
    # the player came back from the notification
    pass

if playgama_bridge_platform_payload() == "come_back" {
    // the player came back from the notification
}

local bridge = require("bridge.bridge")

function init(self)
    if bridge.platform.payload() == "come_back" then
        -- the player came back from the notification
    end
end

if (bridge.platform.payload === 'come_back') {
    // the player came back from the notification
}

PreviousDaily Rewards

NextSocial

Last updated 10 days ago