Developers Docs

Dev docs

Pluvo API Documentation

English only

Welcome to Pluvo developer documentation. Here you'll find technical explanations, examples, and GraphQL definitions for integrating with the Pluvo API. Each document contains practical examples, type descriptions and mutation examples based on the current schedule.

Introduction

The Pluvo API is a GraphQL interface that allows for the management of users, trainings, and events through OAuth authentication. It supports real-time updates via webhooks and provides various scopes for accessing different data types. The API is designed for integration with HRM, CRM, and reporting tools.

Getting Started

Overview of the Pluvo API, including authentication requirements, headers, and endpoint details, along with guidelines for testing, version management, and rate limits.

Concepten & Architectuur

This document provides an overview of Pluvo's API, detailing core concepts such as Users, Groups, Trainings, and Offers, along with its architecture as a GraphQL API. It includes interaction flows and recommended patterns for effective usage.

Users

This document provides an overview of user management functionalities, including methods for retrieving, creating, updating, and archiving users through GraphQL queries and mutations. It outlines use cases, GraphQL type definitions, and important notes regarding user operations.

Groups

This document provides an overview of managing groups via GraphQL, including operations for retrieving, creating, updating, and deleting groups, as well as defining the Group type and its properties.

Group User & Manager

This document provides information on managing user and manager memberships within groups using GraphQL mutations. It includes use cases for adding or removing users and managers, along with the corresponding mutation examples and definitions.

Training / Leerlijnen

This document outlines the structure and functionality of the Training entity in the GraphQL API, detailing actions such as creating, updating, and retrieving learning paths (training). It includes sample queries and mutations, along with definitions of the Training type and related operations.

Offer

The document outlines the structure and functions of an Offer in Pluvo, detailing how it serves as a registration opportunity for participants through OfferEvents. It includes GraphQL queries and mutations for retrieving, creating, updating, and archiving offers, along with definitions of the Offer type and relevant notes on its usage.

OfferEvent & Date

This document outlines the OfferEvent and its associated OfferEventDate, detailing how users can register for events linked to offers, create new events, manage dates, and perform various mutations through GraphQL.

Enrollments

This document provides an overview of enrollments in the Pluvo platform, detailing how to enroll and unenroll users in events using GraphQL queries and mutations. It includes information on checking enrollment status, listing all enrollments for a user, and defining the Enrollment type and its status.

ExtraCategory

The ExtraCategory groups additional fields for collecting information about various objects within Pluvo, such as users and learning journeys. Each category contains multiple ExtraFields, which can store different types of data, including text, numbers, dates, and choices. The document outlines use cases for retrieving, creating, updating, and archiving these categories, as well as details on field types and validation.

Specs of Extra Categories

Details the specifications and technical structure of extra categories in Pluvo, including GraphQL types, value management, and mutations for creating and updating categories.

Portfolioitems

This document details the structure and management of portfolio items, including how to create, retrieve, update, and delete items using GraphQL. It outlines the types of data associated with portfolio items and provides examples of relevant queries and mutations.

PortfolioReport

The document outlines the portfolioReport GraphQL query, detailing its capabilities for retrieving users' portfolio items with various filtering options. It includes use cases, example queries, GraphQL definitions, and notes on filtering by context and status.

Webhooks

This document outlines the use of webhooks in Pluvo, detailing event notifications for various activities such as training, user, group, and portfolio item events. It includes information on security measures for verifying webhook requests and provides example payloads for each event type.

Certificate

Covers the issuance and management of certificates within Pluvo, including how to retrieve available certificate templates and the process for assigning certificates to users via GraphQL mutations. Details structure and types related to certificate queries and mutations, along with best practices for using the system.

Close notification

Pluvo makes learning processes for the municipality of The Hague easy - Customer Story

ARTIS welcomes new volunteers with Pluvo

Start your online HACCP training with Pluvo's e-learning template!