Skip to main content

AsyncAPI for reward service 0.1.0 documentation

Published Messages (rewardManagement)

The service publishes one of these messages below.

rewardCreated

Message is sent when reward is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"rewardManage": {
"namespace": "string",
"rewardCode": "string",
"description": "string",
"eventTopic": "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
rewardManagerewardManage-

rewardUpdated

Message is sent when reward is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"rewardManage": {
"namespace": "string",
"rewardCode": "string",
"description": "string",
"eventTopic": "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
rewardManagerewardManage-

rewardDeleted

Message is sent when reward is deleted. Contains fields from event and the following payload.

Example value
{
"payload": {
"rewardManage": {
"namespace": "string",
"rewardCode": "string",
"description": "string",
"eventTopic": "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
rewardManagerewardManage-

rewardImported

Message is sent when import reward configuration. Contains fields from event and the following payload.

Example value
{
"payload": {
"rewardImport": {
"namespace": "string",
"replacedRewardCodes": [
"string"
],
"ignoredRewardCodes": [
"string"
],
"newRewardCodes": [
"string"
],
"failedRewardCodes": [
"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
rewardImportobject-
payload.rewardImport
NameTypeDescription
namespacestringnamespace
replacedRewardCodesarraylist of replaced reward codes
ignoredRewardCodesarraylist of ignored reward codes
newRewardCodesarraylist of new reward codes
failedRewardCodesarraylist of failed reward codes

Schemas

rewardManage

NameTypeDescription
namespacestringnamespace
rewardCodestringreward code
descriptionstringreward description
eventTopicstringtopic to listen to

event

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