Notifications

The Recommender Platform generates notifications for you to broadcast to the corresponding households. In this section you find articles which help you understand how you can receive notifications from the Recommender Platform and how you can deliver the notifications to the households.

Notification Interactions

The message queue of the Recommender Platform is able to learn from user interactions with the delivered notifications, which notifications are of interest for a specific household. To power these learnings, user interactions with notifications need to be sent back to the Recommender Platform.

In the sub-section "Send Notification Interaction" you find a guide which helps you understand how you can return such an interaction to the Recommender Platform.

API

GEThttps://api.moost.io/pushnotifications/v1

Query parameters

Response

200

OK

Body

application/json

pushNotificationsarray of PushNotification (object)

totalPushNotificationsinteger (int32)

Request

JavaScriptCurl

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

Response

{
  "pushNotifications": [
    {
      "id": {
        "date": "2024-05-08T07:20:24.422Z"
      },
      "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"
      }
    }
  ]
}

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

Path parameters

pushNotificationId*string

Body

application/json

actionQualifierstring

Response

200

OK

Request

JavaScriptCurl

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();