Introduction

English only

GraphQL Interface

  • The Pluvo API is a GraphQL-based interface for managing users, trainings, events, and more.
  • Authentication is handled via an OAuth token based on client_id and client_secret.
  • Webhooks provide real-time updates about enrollments, statuses, and more.
  • Endpoint: https://[organization].pluvo.com/graphql/

The Pluvo API enables external systems such as HRM platforms, and integration tools to programmatically communicate with the Pluvo platform.

Authentication

Access to the API requires an OAuth token that you request via:

POST https://[organization].pluvo.com/oauth/token/

Important:

  • Endpoint requires trailing slash /
  • Headers: Content-Type: application/x-www-form-urlencoded
  • Body parameters:

A valid token is included as a Bearer token in API requests:

Authorization: Bearer <your_token>

Scopes and Access Levels

API Endpoint

All requests are made to:

https://[organization].pluvo.com/graphql/
Note: the trailing slash is also required here.

GraphQL: Brief Overview

The Pluvo API implements a full GraphQL interface.

You determine which fields you retrieve or update, ensuring minimal payloads and maximum flexibility.

Example query:

query user($ref: String!) {
  user(ref: $ref) {
    ref
    name
    email
    isActive
  }
}

The ref serves as a unique identifier within your own system.

You can determine this value yourself when creating an object, as long as it remains unique within the entity.

Webhooks

Pluvo supports webhooks for real-time notifications about:

  • New enrollments
  • Completed courses
  • Changes in user status

Webhook configuration is done through the admin interface of your organization's Pluvo environment.

Each webhook request contains an HMAC signature for verification.

Schließ die Richtung