LTNC Request: Algemene informatie

Algemene informatie

Het doel van de plugin is dat een Moodle sitebeheerder zelfstandig een webhook kan instellen, zodat er een POST request gestuurd wordt naar de URL van een extern systeem. De webhook bevatten gegevens over de cursist en het behaalde resultaat van een cursus.

We hanteren voor het format JSON en XML, en de codering UTF-8.

Om te bepalen of een bericht daadwerkelijk afkomstig is van de Moodle omgeving, dient de URL een secret te bevatten. Alle berichten bevatten dan een X-webhook-signature header met een Base64 gecodeerd HMAC-SHA1 pf HMAC-SHA512 van het bericht en de secret.

Voorbeeld van een webhook url is: https://xxxx/v1/moodle?auth=787929d01943640d2443c552c9121e1f

De webhook URLdie we ontvangen is uniek per omgeving.

Als de URL waar het bericht naar sturen niet binnen 10 seconden een response geeft óf als we geen status 200 terugkrijgen, proberen we het bericht nog maximaal 5 keer af te leveren. Wanneer het bericht niet afgeleverd kan worden, toont de foutcode:999

Het bericht dat via de webhook wordt verstuurd

Het bericht wordt getriggerd door de core\event\Course_Completion.

Hieronder vind je een voorbeeld bericht

{
  "created": "2022-03-30T13:33:54.809Z",
  "event": "eventname Moodle ",
  "id": "5db1cc3b-4306-4689-9eae-971c205c2c10", 
  "course_id": "moodle cursus id",
  "grade": "10.0",
  "user_id": "moodle intern user id ",
  "moodle_user_id": "moodle user idnumber (= Planaday id) "
}

Notificatie bericht bij foutmeldingen

Gebruikers die toegang hebben tot de rapportage log ontvangen een notificatie melding (mits ingesteld door sitebeheerder) als er error meldingen terugkomen.
Het bericht is aan te passen via de taalbestanden en bevat een link naar de website.

Beste {user:firstname},
Er zijn {aantal} foutmeldingen die je aandacht vragen. 
Ga naar de berichtenlog door te klikken op de onderstaande url:
{url}

Rechten

Gebruikers met het recht local/request:viewlog, kunnen de berichtenlog bekijken via de url

https://URLLEEROMGEVING/local/request/view/log.php

Moodle versie

Vanaf Moodle 3.9 , PHP 7.4

Installatie

Je ontvangt het installatie bestand van LT&C (of LT&C installeert het voor je)
Je installeert het blok door in te loggen in de Moodle leeromgeving > Sitebeheer > Plugins > Installeer plugins

Testen

Je kan de webhook testen met https://beeceptor.com/ of https://webhook.site/