Lobby Notification Events 0.1.0 documentation
In this document, PUB
means "publish" and SUB
means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.
- Specification ID:
http://lobby-notification-service
- Protobuf File Spec: notification.proto
Table of Contents
Operations
PUB notifications
Operation
Accepts one of the following messages:
Message freeformNotificationSent
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | object | - | - | - | additional properties are allowed |
payload.notification.senderId | string | - | - | - | - |
payload.notification.namespace | string | - | - | - | - |
payload.notification.topic | string | - | - | - | - |
payload.notification.message | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message freeformNotificationSentToUser
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.targetUserId | string | - | - | - | - |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.senderId | string | - | - | - | - |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.topic | string | - | - | - | - |
payload.notification.0.message | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationCreated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.templateContent | string | - | - | - | - |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.templateSlug | string | - | - | - | - |
payload.notification.0.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationSent
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.topic | string | - | - | - | - |
payload.notification.templateContext | object | - | - | - | additional properties are allowed |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.templateSlug | string | - | - | - | - |
payload.notification.0.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationSentToUser
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.topic | string | - | - | - | - |
payload.notification.templateContext | object | - | - | - | additional properties are allowed |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.templateSlug | string | - | - | - | - |
payload.notification.0.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationDeleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | object | - | - | - | additional properties are allowed |
payload.notification.templateSlug | string | - | - | - | - |
payload.notification.namespace | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"notification": {
"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"
}
Message templatedNotificationLocalizationUpdated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.templateContent | string | - | - | - | - |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.templateSlug | string | - | - | - | - |
payload.notification.0.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationLocalizationDeleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | object | - | - | - | additional properties are allowed |
payload.notification.namespace | string | - | - | - | - |
payload.notification.templateSlug | string | - | - | - | - |
payload.notification.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationLocalizationPublished
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | object | - | - | - | additional properties are allowed |
payload.notification.namespace | string | - | - | - | - |
payload.notification.templateSlug | string | - | - | - | - |
payload.notification.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message freeformNotificationSentToParty
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.partyId | string | - | - | - | - |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.senderId | string | - | - | - | - |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.topic | string | - | - | - | - |
payload.notification.0.message | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message templatedNotificationSentToParty
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.notification | allOf | - | - | - | additional properties are allowed |
payload.notification.topic | string | - | - | - | - |
payload.notification.templateContext | object | - | - | - | additional properties are allowed |
payload.notification.partyId | string | - | - | - | - |
payload.notification.0 (allOf item) | object | - | - | - | additional properties are allowed |
payload.notification.0.namespace | string | - | - | - | - |
payload.notification.0.templateSlug | string | - | - | - | - |
payload.notification.0.templateLanguage | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
PUB topics
Operation
Accepts one of the following messages:
Message topicCreated
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.topic | object | - | - | - | additional properties are allowed |
payload.topic.namespace | string | - | - | - | - |
payload.topic.description | string | - | - | - | - |
payload.topic.topic | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message topicDeleted
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.topic | object | - | - | - | additional properties are allowed |
payload.topic.namespace | string | - | - | - | - |
payload.topic.description | string | - | - | - | - |
payload.topic.topic | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}
Message topicModified
Payload
Name | Type | Description | Value | Constraints | Notes |
---|---|---|---|---|---|
(root) | allOf | - | - | - | additional properties are allowed |
payload | - | - | - | - | additional properties are allowed |
payload.topic | object | - | - | - | additional properties are allowed |
payload.topic.namespace | string | - | - | - | - |
payload.topic.description | string | - | - | - | - |
payload.topic.topic | string | - | - | - | - |
0 (allOf item) | object | - | - | - | additional properties are allowed |
id | string | - | - | - | - |
version | integer | - | - | - | - |
name | string | - | - | - | - |
namespace | string | - | - | - | - |
parentNamespace | string | - | - | - | - |
timestamp | string | - | - | format (date-time ) | - |
clientId | string | - | - | - | - |
userId | string | UserId of the operator for this event (optional) | - | - | - |
traceId | string | - | - | - | - |
sessionId | string | - | - | - | - |
spanContext | string | - | - | - | - |
Examples of payload (generated)
{
"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"
}