Challenge Service Events 1.0.0 documentation

• Protobuf File Spec: challenge.proto

Published Messages (goalCompleted)

The service publishes one of these messages below.

goalCompleted

Contains fields from and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "challengeCode": "string",
    "goalCode": "string",
    "completedAt": "2019-08-24T14:15:22Z",
    "userId": "string",
    "scheduleId": "string",
    "scheduleStart": "2019-08-24T14:15:22Z",
    "scheduleEnd": "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",
  "spanContext": "string"
}

payload

Name	Type	Description
namespace	string	namespace origin of completed goal
challengeCode	string	associated challengeCode from completed goal
goalCode	string	completed goalCode
completedAt	string (date-time)	timestamp of completion
userId	string	userId that completes the goal
scheduleId	string	scheduleId which the goal completed
scheduleStart	string (date-time)	timestamp of the schedule's start time
scheduleEnd	string (date-time)	timestamp of the schedule's end time (optional)

Published Messages (rewardsClaimed)

The service publishes one of these messages below.

rewardsClaimed

Contains fields from and the following payload.

Example value

{
  "payload": {
    "namespace": "string",
    "challengeCode": "string",
    "goalCode": "string",
    "claimedAt": "2019-08-24T14:15:22Z",
    "rewardIds": [
      "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",
  "spanContext": "string"
}

payload

Name	Type	Description
namespace	string	namespace origin of claimed reward's goal
challengeCode	string	associated challengeCode from claimed reward's goal
goalCode	string	claimed reward goalCode
claimedAt	string (date-time)	timestamp of reward(s) claimed
rewardIds	array	list of reward ID(s) claimed
userId	string	userId that got the reward(s)

Schemas