Welcome to Pluvo's API documentation. This document provides an overview of the key concepts and underlying structure of the Pluvo platform. It is intended as a starting point for developers building integrations or synchronizing data with Pluvo.
Participants, trainers, planners, or managers — anyone who logs into Pluvo is a User
. Users can contain additional data (via extraFields
) and are linked to groups or roles.
Organizational units that group users. Groups determine access to trainings and can have their own settings and managers.
A Training
contains learning content, progress rules, and scheduling. What users see as a "learning journey" in the interface is called a Training
in the API.
An Offer
is the overarching enrollment offering. An OfferEvent
is a specific entry point. Users enroll in an OfferEvent
.
A PortfolioItem
stores evidence, achievements, or certificates. PortfolioReport
is an advanced query for analyzing progress, scores, and time spent.
Within a Training
you'll find Modules
that contain e-learning content such as videos, theory, assignments, or external LTI modules.
Pluvo can push events to your system. Examples include USER_CREATED
, TRAINING_FINISHED
, and COURSE_FINISHED
.
The Pluvo API is built as a GraphQL API. Key features:
User
, Training
, Group
, etc.)ref
fields for external connectionsExample flows within Pluvo:
updateOrCreateUser
and updateExtraCategoryValues
for robust synchronization.archiveUsers
, archiveOffers
, etc.).PortfolioReport
for evaluation and monitoring purposes.ref
, id
, and contentType
.