Return Notification Interaction

Introduction

To train our algorithms based on the actions taken by End-users, it is important that the action qualifier, which identifies the action that was taken by the End-user, is returned to the Recommender Platform.

You need to be authenticated to be able to send the interaction back to the Recommender Platform API. Please refer to “API Authentication” for further details on how to obtain a valid bearer token.

How to send a Push-notification interaction

Each notification is delivered with a unique ID to the customer’s REST Endpoint. (See Receive Notifications | Notification Fields for a full list of fields that are contained on the notification object). The MOOST Recommender Platform exposes the interaction endpoint on to which the actionQualifer of the clicked action can be sent.

When to send notification interactions

Notification interactions must be returned to MOOST on any interaction the enduser has with a notification. This includes to following interactions:

• Pressing the primary button

• Pressing the secondary button

• Pressing on the notification itself

• Dismissing the Notification (Swipe left)

Request

To send an actionQualifier back to the MOOST Recommender Platform you need to include the bearer token in the authorization field and send the actionQualifier for the taken action (which you can find in the notification object see Receive Notifications) as body back to the API.

{
    "actionQualifier": "DISMISS"
}

Example

curl -X POST 'https://api.moost.io/pushnotifications/62f39eef7c1451044766e072/interactions/v1' \
--header 'Authorization: Bearer YOUR_BEARER_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "actionQualifier": "DISMISS"
}'

Response

The Recommender Platform responds with one of the following HTTP Status Codes.

HTTP Status Code	Description
200 - OK	The interaction was successfully saved for the given pushnotification ID.
401 - Unauthorized	The caller was not authorized to set the interaction for the given pushnotification ID.
403 - Forbidden	The bearer token in the Authorization header was invalid.
404 - Not Found	The pushnotification with the given ID was not found.