Message format – entitlement changes

Overview

OPF’s Right Manager (RMG) can notify an account’s devices when an entitlement for the account is created, updated, or deleted.

Message format

Example payload of an entitlement change message:

{
  "data": { 
    "body": "{
      "productId": "Product_123",
      "accountId": "Account_2356425",
      "deviceId": "Mobile_55414",
      "status": "Subscribed",
      "validFrom": "2025-08-12",
      "expiryDate": "2025-08-31"
    }", 
    "title": "ENTITLEMENT_UPDATE",
    "referenceType": "ENTITLEMENT_UPDATE" 
  }
}

The message is delivered as stringified JSON, and is shown here as regular JSON for readability.

When delivered to the client, the above example JSON will be stringified as follows:

JSON

"{\"data\":{\"body\":{\"productId\":\"Product_123\",\"accountId\":\"Account_2356425\",\"deviceId\":\"Mobile_55414\",\"status\":\"Subscribed\",\"validFrom\":\"2025-08-12\",\"expiryDate\":\"2025-08-31\"},\"title\":\"ENTITLEMENT_UPDATE\",\"referenceType\":\"ENTITLEMENT_UPDATE\"}}"

The notification contains all the information that the client requires to update its cached entitlement information without having to make any additional calls to RMG.