onAchievementRewardClaimed

Description:

Executed when a reward was claimed by a member.

This assumes that a webhook has been registered to trap and execute the trigger on this type of event.

Resource URL:

https://your-endpoint

Request header

KeyValueRequired
Content-Type
application/jsonYes
Accept-Encoding
gzipYes
User_Agent
CompetitionLabs/1.0Yes
X-Account
Unique identifier of your accountYes
X-OnEvent
onAchievementRewardIssuedYes

Request Body Parameters:

Below are the default body parameters which will be posted to your endpoint, if no transformer is provided.

Parameter
Type
Constraint
Description
achievementId
StringCase sensitiveCompetitionLabs unique identifier for achievement
memberId
StringCase sensitiveCompetitionLabs unique identifier for member
memberRefId
StringCase sensitiveYour member reference identifier
awardId
StringCase sensitiveCompetitionLabs unique identifier for award
resourcePath
StringCase sensitivePath to element relative to CompetitionLabs url
timestamp
Long
Date time for trigger in UTC in milli seconds
spaceName
StringCase sensitiveThe space name you are using the webhooks on
objectTypeStringCase sensitiveThe type of a webhook call

Example:

Response for query string request
{
  "achievementId": "<cl-achievement-id>",
  "memberId": "<cl-member-id>",
  "memberRefId": "my-customer-member-ref-1",
  "awardId": "<cl-award-id>",
  "resourcePath": "/api/<your-space-name>/awards/<cl-awards-id>",
  "timestamp": 1505478547552,
  "spaceName": "<your-space-name>",
  "objectType": "AchievementRewardClaimed"
}