Skip to main content

Legal Service Agreement Events 0.1.0 documentation

Published Messages (agreement)

The service publishes one of these messages below.

agreementCreated

Message is sent after user accepts legal documentation. Contains fields from event and the following payload.

Example value
{
"payload": {
"agreement": {
"policyId": "string",
"policyVersionId": "string",
"policyName": "string",
"displayVersion": "string",
"localizedPolicyVersionId": "string",
"localizedDescription": "string",
"isAccepted": true,
"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
agreementagreement-

agreementUpdated

Message is sent after user accepts legal documentation. Contains fields from event and the following payload.

Example value
{
"payload": {
"agreement": {
"policyId": "string",
"policyVersionId": "string",
"policyName": "string",
"displayVersion": "string",
"localizedPolicyVersionId": "string",
"localizedDescription": "string",
"isAccepted": true,
"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
agreementagreement-

Schemas

agreement

NameTypeDescription
policyIdstringpolicy id
policyVersionIdstringpolicy version id
policyNamestringpolicy name
displayVersionstringdisplay version of policy version
localizedPolicyVersionIdstringlocalized policy version id
localizedDescriptionstringdescription of localized policy
isAcceptedbooleana flag indicates whether user accepted this policy
userIdstringuser id, can be publisher/game user id

event

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