Message

Message
Message

A message for display to a particular user, all users within a customer, or all users on a cluster

JSON Example
{
    "source": "string",
    "severity": "string",
    "id": "string",
    "target": "string",
    "content": "string",
    "scope": "string",
    "startEpochMillis": 0,
    "endEpochMillis": 0,
    "display": "string",
    "title": "string",
    "read": false
}
string
source
Required

Message source. System messages will com from '[email protected]'

string
severity
Required

Message severity

Possible values are : MARKETING, INFO, WARN, SEVERE,
string
id
Optional

id

string
target
Optional

For scope=CUSTOMER or scope=USER, the individual customer or user id

string
content
Required

Message content

object
attributes
Optional

A string->string map of additional properties associated with this message

string
scope
Required

The audience scope that this message should reach

Possible values are : CLUSTER, CUSTOMER, USER,
integer As int64 As int64
startEpochMillis
Required

When this message will begin to be displayed, in epoch millis

integer As int64 As int64
endEpochMillis
Required

When this message will stop being displayed, in epoch millis

string
display
Required

The form of display for this message

Possible values are : BANNER, TOASTER, MODAL,
string
title
Required

Title of this message

boolean
read
Optional

A derived field for whether the current user has read this message