Notifications and Interactions

The notifications are sent to you via the configured endpoint, see Configure Notification Settings. Nevertheless you might want to render a list of delivered notifications at a later time.

Use following MOOST API to achieve that

Set an Interaction on a delivered Notification

When the push notification is sent to a end-customer (typically to a mobile app), then this person shall have the possibility to interact to the notification. The app shall then send the interaction type with following API call:

Save an interaction on a delivered push notification

POSThttps://api.moost.io/pushnotifications/{pushNotificationId}/interactions/v1

Path parameters

pushNotificationId*string

Select specified notification.

Pattern: ^[a-zA-Z0-9]{24}$

Body

application/json

Save specified interaction. The interaction has to be of form: {"actionQualifier": "DISMISS"}.Valid actionQualifier values are: "DISMISS", "OPENAPP", "STOPDELIVERY", "OPENWEB"

actionQualifierstring

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.moost.io/pushnotifications/{pushNotificationId}/interactions/v1', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Example with CURL

# make sure ACCESS_TOKEN is set and valid (see "Request Access Token")
curl -X POST "https://api.moost.io/pushnotifications/668b8e708f308b0123074cb7/interactions/v1" \
     -H  "Authorization: Bearer $ACCESS_TOKEN" \
     -H  "Content-Type: application/json" -d "{\"actionQualifier\":\"OPENWEB\"}"

Load Notifications of a Building

The app shall have the possibility to display the generated notifications. Following API can be used to fulfill this need.

Get push notifications of a building

GEThttps://api.moost.io/pushnotifications/buildings/{customerBuildingId}/v1

Path parameters

customerBuildingId*string

Select notifications of specified building.

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

Query parameters

Response

200

OK

Body

application/json

idObjectId (object)

customerId*string

Pattern: ^[a-zA-Z0-9]{24}$

userId*string

Pattern: ^[a-zA-Z0-9:._-]{1,100}$

ruleId*string

Pattern: ^[a-zA-Z0-9]{24}$

priorityenum

highnormal

createdAtTimeMillisinteger (int64)

interactionPushNotificationInteraction (object)

ingestionTimestampinteger (int64)

messageTranslatable (object)

titleTranslatable (object)

actionsarray of NotificationAction (object)

delivery_statusPushNotificationDeliveryStatus (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.moost.io/pushnotifications/buildings/{customerBuildingId}/v1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": {
      "date": "2024-10-23T08:04:38.545Z"
    },
    "customerId": "text",
    "userId": "text",
    "ruleId": "text",
    "priority": "high",
    "interaction": {
      "actionQualifier": "DISMISS"
    },
    "message": {
      "de": "text",
      "en": "text",
      "fr": "text"
    },
    "title": {
      "de": "text",
      "en": "text",
      "fr": "text"
    },
    "actions": [
      {
        "text": {
          "de": "text",
          "en": "text",
          "fr": "text"
        },
        "actionQualifier": "DISMISS",
        "parameter": {
          "de": "text",
          "en": "text",
          "fr": "text"
        }
      }
    ],
    "delivery_status": {
      "status": "DELIVERED",
      "reason": "text"
    }
  }
]

Example with CURL

curl -X GET "https://api.moost.io/pushnotifications/buildings/99900000ECA31C6E/v1?deliveryStatus=DELIVERED" \
     -H  "Authorization: Bearer $ACCESS_TOKEN"