Last updated on July 3, 2025

Lobby Notification Events 0.1.0 documentation

Protobuf File Spec: lobby.proto

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`

Name	Type	Description
notification	notificationPayload	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
targetUserId	string	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
templateContent	string	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
topic	string	-
templateContext	object	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
topic	string	-
templateContext	object	-

`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`

Name	Type	Description
templateSlug	string	-
namespace	string	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
templateContent	string	-

`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`

Name	Type	Description
notification	localizedTemplatePayload	-

`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`

Name	Type	Description
notification	localizedTemplatePayload	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
partyId	string	-

`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`

Name	Type	Description
notification	object	-

`payload.notification`

Name	Type	Description
topic	string	-
templateContext	object	-
partyId	string	-

`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`

Name	Type	Description
topic	topicsPayload	-

`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`

Name	Type	Description
topic	topicsPayload	-

`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`

Name	Type	Description
topic	topicsPayload	-

Schemas

notificationPayload

Name	Type	Description
senderId	string	-
namespace	string	-
topic	string	-
message	string	-

localizedTemplatePayload

Name	Type	Description
namespace	string	-
templateSlug	string	-
templateLanguage	string	-

templatedNotificationDeletedNotification

Name	Type	Description
templateSlug	string	-
namespace	string	-

topicsPayload

Name	Type	Description
namespace	string	-
description	string	-
topic	string	-

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	UserId of the operator for this event (optional)
traceId	string	-
sessionId	string	-
spanContext	string	-

Published Messages (notifications)​

freeformNotificationSent​

payload​

freeformNotificationSentToUser​

payload​

payload.notification​

templatedNotificationCreated​

payload​

payload.notification​

templatedNotificationSent​

payload​

payload.notification​

payload.notification.templateContext​

templatedNotificationSentToUser​

payload​

payload.notification​

payload.notification.templateContext​

templatedNotificationDeleted​

payload​

templatedNotificationLocalizationUpdated​

payload​

payload.notification​

templatedNotificationLocalizationDeleted​

payload​

templatedNotificationLocalizationPublished​

payload​

freeformNotificationSentToParty​

payload​

payload.notification​

templatedNotificationSentToParty​

payload​

payload.notification​

payload.notification.templateContext​

Published Messages (topics)​

topicCreated​

payload​

topicDeleted​

payload​

topicModified​

payload​

Schemas​

notificationPayload​

localizedTemplatePayload​

templatedNotificationDeletedNotification​

topicsPayload​

event​

Published Messages (notifications)

`freeformNotificationSent`

`payload`

`freeformNotificationSentToUser`

`payload`

`payload.notification`

`templatedNotificationCreated`

`payload`

`payload.notification`

`templatedNotificationSent`

`payload`

`payload.notification`

`payload.notification.templateContext`

`templatedNotificationSentToUser`

`payload`

`payload.notification`

`payload.notification.templateContext`

`templatedNotificationDeleted`

`payload`

`templatedNotificationLocalizationUpdated`

`payload`

`payload.notification`

`templatedNotificationLocalizationDeleted`

`payload`

`templatedNotificationLocalizationPublished`

`payload`

`freeformNotificationSentToParty`

`payload`

`payload.notification`

`templatedNotificationSentToParty`

`payload`

`payload.notification`

`payload.notification.templateContext`

Published Messages (topics)

`topicCreated`

`payload`

`topicDeleted`

`payload`

`topicModified`

`payload`

Schemas

notificationPayload

localizedTemplatePayload

templatedNotificationDeletedNotification

topicsPayload

event