Skip to main content
Last updated on September 30, 2025

UGC Service Events 0.1.0 documentation

Published Messages (ugcContent)​

The service publishes one of these messages below.

ugcContentUpdated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContent": {
"contentId": "string",
"namespace": "string",
"channel": "string",
"userId": "string",
"createdTime": "2019-08-24T14:15:22Z",
"isOfficial": true,
"updatedTime": "2019-08-24T14:15:22Z",
"tags": [
"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"
}

payload​

NameTypeDescription
ugcContentugcContent-

ugcContentDeleted​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContentDelete": {
"namespace": "string",
"contentId": "string",
"userId": "string",
"deleteBy": "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"
}

payload​

NameTypeDescription
ugcContentDeleteobject-
payload.ugcContentDelete​
NameTypeDescription
namespacestring-
contentIdstring-
userIdstring-
deleteBystring-

ugcContentHide​

Contains fields from event and the following payload.

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

payload​

NameTypeDescription
ugcContentHideugcContentHide-

ugcContentUnHide​

Contains fields from event and the following payload.

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

payload​

NameTypeDescription
ugcContentHideugcContentHide-

ugcContentCreated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContent": {
"contentId": "string",
"namespace": "string",
"channel": "string",
"userId": "string",
"createdTime": "2019-08-24T14:15:22Z",
"isOfficial": true,
"updatedTime": "2019-08-24T14:15:22Z",
"tags": [
"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"
}

payload​

NameTypeDescription
ugcContentugcContent-

ugcContentLiked​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContentLike": {
"namespace": "string",
"userId": "string",
"creatorId": "string",
"contentId": "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"
}

payload​

NameTypeDescription
ugcContentLikeugcContentLike-

ugcContentUnLiked​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContentLike": {
"namespace": "string",
"userId": "string",
"creatorId": "string",
"contentId": "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"
}

payload​

NameTypeDescription
ugcContentLikeugcContentLike-

Published Messages (ugcChannel)​

The service publishes one of these messages below.

ugcChannelCreated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcChannel": {
"namespace": "string",
"channelId": "string",
"userId": "string",
"channelName": "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"
}

payload​

NameTypeDescription
ugcChannelugcChannel-

ugcChannelUpdated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcChannel": {
"namespace": "string",
"channelId": "string",
"userId": "string",
"channelName": "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"
}

payload​

NameTypeDescription
ugcChannelugcChannel-

ugcChannelDeleted​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcChannel": {
"namespace": "string",
"channelId": "string",
"userId": "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"
}

payload​

NameTypeDescription
ugcChannelobject-
payload.ugcChannel​
NameTypeDescription
namespacestring-
channelIdstring-
userIdstring-

Published Messages (ugcCreator)​

The service publishes one of these messages below.

ugcCreatorCreated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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"
}

payload​

NameTypeDescription
ugcCreatorugcCreator-

ugcCreatorFollowed​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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"
}

payload​

NameTypeDescription
ugcCreatorugcCreator-

ugcCreatorUnFollowed​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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"
}

payload​

NameTypeDescription
ugcCreatorugcCreator-

ugcCreatorDeleted​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcCreator": {
"namespace": "string",
"userId": "string",
"creatorId": "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"
}

payload​

NameTypeDescription
ugcCreatorugcCreator-

ugcCreatorBanned​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcCreatorBan": {
"namespace": "string",
"userId": "string",
"reason": "string",
"type": "string",
"enable": true,
"endDate": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
ugcCreatorBanugcCreatorBan-

ugcCreatorUnBanned​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcCreatorBan": {
"namespace": "string",
"userId": "string",
"reason": "string",
"type": "string",
"enable": true,
"endDate": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
ugcCreatorBanugcCreatorBan-

Published Messages (ugcContentGroup)​

The service publishes one of these messages below.

ugcContentGroupCreated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContentGroup": {
"namespace": "string",
"groupId": "string",
"name": "string",
"userId": "string",
"contents": [
"string"
],
"createdTime": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
ugcContentGroupugcContentGroup-

ugcContentGroupUpdated​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContentGroup": {
"namespace": "string",
"groupId": "string",
"name": "string",
"userId": "string",
"contents": [
"string"
],
"createdTime": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
ugcContentGroupugcContentGroup-

ugcContentGroupDeleted​

Contains fields from event and the following payload.

Example value
{
"payload": {
"ugcContentGroup": {
"namespace": "string",
"groupId": "string",
"name": "string",
"userId": "string",
"contents": [
"string"
],
"createdTime": "2019-08-24T14:15:22Z"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload​

NameTypeDescription
ugcContentGroupugcContentGroup-

Schemas​

ugcContent​

NameTypeDescription
contentIdstring-
namespacestring-
channelstring-
userIdstring-
createdTimestring (date-time)-
isOfficialboolean-
updatedTimestring (date-time)-
tagsarray-

ugcContentHide​

NameTypeDescription
namespacestring-
contentIdstring-
userIdstring-
autoModerationboolean-

ugcContentLike​

NameTypeDescription
namespacestring-
userIdstring-
creatorIdstring-
contentIdstring-

ugcChannel​

NameTypeDescription
namespacestring-
channelIdstring-
userIdstring-
channelNamestring-

ugcCreator​

NameTypeDescription
namespacestring-
userIdstring-
creatorIdstring-

ugcCreatorBan​

NameTypeDescription
namespacestring-
userIdstring-
reasonstring-
typestring-
enableboolean-
endDatestring (date-time)-

ugcContentGroup​

NameTypeDescription
namespacestring-
groupIdstring-
namestring-
userIdstring-
contentsarray-
createdTimestring (date-time)-

event​

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstring-
traceIdstring-
sessionIdstring-