Product documentation

2024-02-26 Developer notes

--We also added the privatePrices field to the CourseTemplateCreateInput so that private prices can be supplied on Course Template creation

  1. Core API
  2. LMS API
  3. WebLink API
  4. WebLink Widgets

Core API & WebHooks    Documentation | Deprecation Notices

Features

  • We have implemented HMAC Authentication for Webhooks. All webhooks now include:

    • the X-Administrate-signature header containing a SHA512 hash of the payload
    • the metadata.sent_at field with the timestamp when the request was sent
  • Webhooks whose requests to the external service return status codes from 400 to 499 (except 429) will also not be retried any more

  • When using the Course Template create and update mutations, users can specify:

    • learningCategories
    • approvedInstructors
    • learningTagIds
    • companyId
    • levelId
    • shortcode
    • minPlaces
    • maxPlaces
    • cpe
  • When querying Course Templates, you can now fetch company, shortcode, minPlaces, and maxPlaces

  • We added the ability to override the Schedule specified by a Course Template when creating Classroom and Blended events

  • We added the following mutations in CourseTemplateMutations to update Course Template public and private prices:

    • addPublicPrices

    • addPrivatePrices

    • updatePrices

    • deletePrices

      –We also added the privatePrices field to the CourseTemplateCreateInput so that private prices can be supplied on Course Template creation

  • The Session Update mutation now takes an optional lifecycleState input value. If not provided, the Lifecycle State remains unchanged

  • We have added new addStaff and removeStaff Session mutations. These allow users to add and remove staff members to/from individual Event Sessions

Fixes

  • We improved things around Event Learner prices so that:

    • you can query priceLevel on a Learner

    • the field Learner.priceLevelId has been deprecated

    • EventMutations.registerContacts has changed:

      • field currencyCode has been deprecated and replaced by financialUnitId
      • new field financialUnitId now supports Token Types to add students priced in Training Tokens
      • an optional priceLevelId can be specified which will set the Price Level, amount and currency or token on the newly created learners

LMS API   Documentation | Deprecation Notices

None

WebLink API    Documentation | Deprecation Notices

None

WebLink Widgets    Documentation

None