Home
Adobe Captivate
Learning Manager Webhooks Badge Awarded Payload Structure
Learning Manager Webhooks Badge Awarded Payload Structure
BadgeAwardedPayload schema from Adobe Learning Manager Webhooks
Type:
Properties: 0
Authoring Education eLearning LMS SCORM Training xAPI
BadgeAwardedPayload is a JSON Structure definition published by Adobe Captivate. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-structure/learning-manager-webhooks-badge-awarded-payload-structure.json",
"name": "BadgeAwardedPayload",
"description": "BadgeAwardedPayload schema from Adobe Learning Manager Webhooks",
"allOf": [
{
"type": "object",
"description": "Base schema for all webhook event payloads",
"required": [
"eventType",
"eventId",
"accountId",
"timestamp"
],
"properties": {
"eventType": {
"type": "string",
"description": "The type of event that triggered this webhook"
},
"eventId": {
"type": "uuid",
"description": "Unique identifier for this event instance"
},
"accountId": {
"type": "string",
"description": "The Learning Manager account ID"
},
"timestamp": {
"type": "datetime",
"description": "ISO 8601 timestamp when the event occurred"
},
"source": {
"type": "string",
"description": "The system component that generated the event",
"enum": [
"learner",
"admin",
"manager",
"system",
"api"
]
}
}
},
{
"type": "object",
"properties": {
"eventType": {
"const": "BADGE_AWARDED"
},
"learner": {
"type": "object",
"description": "Reference to a learner involved in an event",
"properties": {
"userId": {
"type": "string",
"description": "Unique user identifier"
},
"name": {
"type": "string",
"description": "Learner's full name"
},
"email": {
"type": "string",
"format": "email",
"description": "Learner's email address"
}
}
},
"badge": {
"type": "object",
"properties": {
"badgeId": {
"type": "string",
"description": "Badge identifier"
},
"name": {
"type": "string",
"description": "Badge name"
},
"imageUrl": {
"type": "uri",
"description": "Badge image URL"
}
}
},
"dateAwarded": {
"type": "datetime",
"description": "Award timestamp"
}
}
}
]
}