README.md

blackbaud.js

Node.js package to interact with Blackbaud's learning management system (LMS)

Example

const { Client } = require("blackbaud.js");

const client = new Client({
  url: "example.myschoolapp.com",
  svcToken: "ExampleSVCToken", // This can be fetched by looking for the "AuthSvcToken" cookie under "myschoolapp.com" in your browser.
  /* username: "john.doe",
  password: "JohnDoePassword123",*/ // Alternatively, you can provide credentials if the LMS does not use BBID.
});
let UserManager = new client.UserManager(client);

client.on("ready", async function (client) {
  console.log(
    `[Blackbaud] Client logged in and ready as "${client.user.username}"`
  );

  await UserManager.getStatus().then((data) => {
    console.log(data.partial.unreadMessageCount); // Returns the number of unread messages for the current user.
  });
});