Developer docs
De Pluvo API geeft je programmatische toegang tot je leeromgeving. Beheer gebruikers, groepen, trainingen, inschrijvingen en certificaten vanuit je eigen systemen.
De API is gebaseerd op GraphQL. Je bepaalt zelf welke data je opvraagt of muteert, zonder overbodige velden. Authenticatie verloopt via OAuth 2.0 met client credentials. Webhooks houden je systemen real-time op de hoogte van wijzigingen.
Use Cases
What is known in the Pluvo user interface as a learning journey is designated in the API as a Training. All actions related to learning journeys are handled through the Training entity in the GraphQL API.
Get single training
Retrieves one specific training via id or ref.
query {
training(id: "uuid-here") {
id
title
ref
isActive
archived
startDate
endDate
subtitle
introduction
}
}Get list
Use paginatedTrainings to retrieve trainings with filtering, pagination, and sorting.
query {
paginatedTrainings(q: "safety", first: 10, archived: false) {
edges {
node {
id
title
ref
isActive
archived
}
}
pageInfo {
hasNextPage
endCursor
}
count
}
}Create training
Creates a new training with title and optionally other metadata.
mutation {
createTraining(training: {
title: "Introduction to Safe Working"
isActive: true
ref: "safety-2024"
subtitle: "Mandatory annual training"
startDate: "2024-01-01T00:00:00Z"
endDate: "2024-12-31T00:00:00Z"
showParticipants: true
enableChat: false
}) {
training {
id
title
ref
}
}
}Update training
Modifies data of an existing training. You can identify the training by id or ref.
mutation {
updateTraining(
ref: "safety-2024"
training: {
title: "Updated Title"
isActive: false
}
) {
training {
id
title
isActive
}
}
}Archive/deactivate
Sets the training to archived. Archived trainings are hidden from users.
mutation {
updateTraining(
id: "uuid-here"
training: {
archived: true
}
) {
training {
id
archived
}
}
}GraphQL Definitions
Type
type Training {
id: UUID!
title: String!
subtitle: String
introduction: String
ref: String
isActive: Boolean!
archived: Boolean!
overviewImage: File
startDate: Date
endDate: Date
estimatedTimeSpent: String
showParticipants: Boolean
showSharedFiles: Boolean
enableChat: Boolean
portfolioItem: PortfolioItemListItem
participants(...): TrainingUserConnection!
trainers(...): TrainingUserConnection!
modules: [Module!]!
}Queries
training(id: UUID, ref: String): Training
trainings(query: String): [TrainingListItem!] @deprecated(reason: "Use paginatedTrainings")
paginatedTrainings(
q: String
active: Boolean
archived: Boolean
first: Int
after: String
offset: Int
sortBy: TrainingSortByInput
): TrainingListItemConnectionMutations
createTraining(training: CreateTrainingInput!): CreateTraining
updateTraining(id: UUID, ref: String, training: UpdateTrainingInput!): UpdateTrainingCreateTrainingInput
| Field | Type | Required | Description |
|---|---|---|---|
title | String | Yes | Training title |
ref | String | No | External reference |
subtitle | String | No | Subtitle displayed below the title |
introduction | String | No | Introduction text (HTML) |
isActive | Boolean | No | Whether the training is visible |
startDate | DateTime | No | Training start date |
endDate | DateTime | No | Training end date |
estimatedTimeSpent | String | No | Estimated time to complete |
passThreshold | Float | No | Minimum score to pass |
showParticipants | Boolean | No | Show participant list |
showSharedFiles | Boolean | No | Show shared files section |
enableChat | Boolean | No | Enable chat functionality |
extraFields | JSONString | No | Legacy extra fields |
UpdateTrainingInput additionally supports archived (Boolean).
Notes
- Use
paginatedTrainingsfor list views —trainingsis deprecated. - No
deleteTrainingmutation — use archiving viaupdateTrainingwitharchived: true. - Both
archivedandisActiveexist for backward compatibility. Preferarchived. - The
reffield is your anchor for synchronization — always set it for externally managed trainings.