DOCS

A notification is a message that is displayed outside your app's UI to provide the user with reminders, communication from other people, or other timely information from your app. Users can tap the notification to open your app or take an action directly from the notification.

The most common parts of a notification are indicated in figure below:

Every notification open an appropriate app when tapped. In addition to this default notification action, you can add action buttons that complete an app-related task from the notification, as shown in figure below.

By default, the notification's text content is truncated to fit on one line. If you want your notification to be longer, you can enable a larger text area that's expandable by setting the text to long_text in MessageData.

You can also create an expandable notification with an image by setting the URL to large_image in MessageData. But, an expandable notification cannot have both fields large_image and long_text

You can send push notifications in either of the following ways:

From Fawi Office Notification menu without coding required for sending messages.

Or with more flexibility sending messages from your server by invoking Fawi Notifications APIs.

In all cases, for your application to receive notification you will need to subscribe to the topics, for which you have to use Push Notifications API.

Sending a Push Nottification in Fawi Office

1. Sign in to Fawi Office.

Sending a Push Notification by Calling Fawi Notifications APIs

This API is used to send push notifications.

Protocol: HTTPS

Method: POST

URL: https://www.fawiapis.com/notification/send

Sending push notifications in this way the App Secret Key is needed for sending messages. For details about how to obtain the App Secret Key, please refer to Server Publish Settings.

Request Parameters (HTTP Header)

PARAMETERS

Content-Type: application/json

Authorization: Bearer <app_secret_key>

Request Parameters (HTTP body)

The request body contains data with the following structure(JSON):

{
    "validate_only"?: boolean,
    "message": {
        object(Message)
    }
}                                    

PARAMETERS

[optional] validate_only: boolean Flag for testing the request without actually delivering the message. The default value is false

[required] message: object(Message) Notification message structure. Must contain the valid JSON Message payload.

API request example

    POST https://www.fawiapis.com/notification/send HTTP/1.1
Content-Type: application/json
Authorization: Bearer your_app_secret_key

{
    "validate_only": false, 
    "message":{
        "to": "geral",
        "data": {
            "title": "New level",
            "text": "Do you want to play now?",         
            "image": "https://www.example.com/data/806962_user.png", 
            "action_buttons": [{"label":"PLAY", "extra_info":"action_play"},
                               {"label":"DISMISS", "extra_info":"action_play"}]
        }
    }
}

Message

The Message object contains the foolowin stucture:

{
    "to": string,
    "data": {
        object(MessageData)
    }
}                                    

PARAMETERS

[required] to: string Notification topic

[required] data: object(MessageData)

{
    "title": string,
    "text"?: string,
    "long_text"?: string,
    "image"?: string,
    "large_image"?: string,
    "extra_info"?: string,
    "action_buttons"?: {
        object(ActionButton)[3]
    }
    
}                                    

{
    "label": string,
    "extra_info": string
}                                    

{
    "result": string,
    "message": string
}