Skip to main content

Lobby Notification Events 0.1.0 documentation

Published Messages (notifications)

The service publishes one of these messages below.

freeformNotificationSent

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"senderId": "string",
"namespace": "string",
"topic": "string",
"message": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationnotificationPayload-

freeformNotificationSentToUser

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"targetUserId": "string",
"senderId": "string",
"namespace": "string",
"topic": "string",
"message": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
targetUserIdstring-

templatedNotificationCreated

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"templateContent": "string",
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
templateContentstring-

templatedNotificationSent

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"topic": "string",
"templateContext": {},
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
topicstring-
templateContextobject-
payload.notification.templateContext

This is a free-form object.

templatedNotificationSentToUser

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"topic": "string",
"templateContext": {},
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
topicstring-
templateContextobject-
payload.notification.templateContext

This is a free-form object.

templatedNotificationDeleted

Contains fields from event and the following payload.

Example value
{
"payload": {
"templateSlug": "string",
"namespace": "string"
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
templateSlugstring-
namespacestring-

templatedNotificationLocalizationUpdated

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"templateContent": "string",
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
templateContentstring-

templatedNotificationLocalizationDeleted

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationlocalizedTemplatePayload-

templatedNotificationLocalizationPublished

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationlocalizedTemplatePayload-

freeformNotificationSentToParty

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"partyId": "string",
"senderId": "string",
"namespace": "string",
"topic": "string",
"message": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
partyIdstring-

templatedNotificationSentToParty

Contains fields from event and the following payload.

Example value
{
"payload": {
"notification": {
"topic": "string",
"templateContext": {},
"partyId": "string",
"namespace": "string",
"templateSlug": "string",
"templateLanguage": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
notificationobject-
payload.notification
NameTypeDescription
topicstring-
templateContextobject-
partyIdstring-
payload.notification.templateContext

This is a free-form object.

Published Messages (topics)

The service publishes one of these messages below.

topicCreated

Contains fields from event and the following payload.

Example value
{
"payload": {
"topic": {
"namespace": "string",
"description": "string",
"topic": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
topictopicsPayload-

topicDeleted

Contains fields from event and the following payload.

Example value
{
"payload": {
"topic": {
"namespace": "string",
"description": "string",
"topic": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
topictopicsPayload-

topicModified

Contains fields from event and the following payload.

Example value
{
"payload": {
"topic": {
"namespace": "string",
"description": "string",
"topic": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string",
"spanContext": "string"
}

payload

NameTypeDescription
topictopicsPayload-

Schemas

notificationPayload

NameTypeDescription
senderIdstring-
namespacestring-
topicstring-
messagestring-

localizedTemplatePayload

NameTypeDescription
namespacestring-
templateSlugstring-
templateLanguagestring-

templatedNotificationDeletedNotification

NameTypeDescription
templateSlugstring-
namespacestring-

topicsPayload

NameTypeDescription
namespacestring-
descriptionstring-
topicstring-

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstringUserId of the operator for this event (optional)
traceIdstring-
sessionIdstring-
spanContextstring-