Sending a Push Notification from the API Endpoint

Hitting /pushdata/sendnotification endpoint ( Eg calling from FileMaker Server)

  • Create a POST request to the following endpoint: https://your.domain.com/pushdata/sendnotification

  • Set the body of the request will be as follows:

{
    "apiKey": "BFAPI_YOUR_KEY",
    "body": "Hello from BF push notification!",
    "data": {
        "dateOfArrival_calc": "Date.now()",
        "path": "/"
    },
    "icon": "LINK_TO_YOUR_ICON",
    "title": "BF's New Feature!!!",
    "vibrate": [100, 50, 100],
    "filter": {
        "users": ["BF_USER_ID"]
    },
    "ttl": 300
}

The filter key is optional, only needed when push notifications should be sent only to specific users. General push notifications can be sent without the filter key. Another optional key is ttl, which defines how long a notification will stay alive if a user is offline (e.g.: ttl is set to 300 seconds, so if a user is offline, the notification will be delivered to the user if the user comes back online within 5 minutes). The default value set to ttl, if no value is passed, is 300 seconds.

Last updated