Wisenet’s Webhooks Connected App allows users to set up subscriptions to certain Wisenet events.
Best practices for using Webhooks
To ensure your Webhooks remain secure and function well with your integration:
- Handle duplicate events by logging the events you’ve processed and then not processing already-logged events.
- Configure event types to only receive the specific events required rather than all events.
- Configure events queue to process incoming events asynchronously to avoid a bottleneck when there are a large number of webhook deliveries.
- Enhance security to only receive events with an HTTPS server.
- Use a unique secret key for each endpoint if you are using multiple endpoints.
Event Payload
The Event Payload is designed to provide event identifiers only and not the full record payload. This is for security purposes.
The Event Payload includes
- AccountNumber: Your unique account code
- RecordId: The Id of the record used in the API for filtering
- RecordGuid: The guid of the record
- EntityName: The entity of the record eg. CourseEnrolment
- Event: The type of Event Trigger eg. Created, Updated, Deleted or Triggered (Triggered is when from a learncycle)
Event Triggers
Event Triggers differ between entities due to differences in entity design.
The event triggers that are currently available for Webhooks:
| Entity | Create | Update | Delete | Learncycle Trigger |
| Learner | ✔ | ✔ | ✔ | ✔ |
| Course Enrolment | ✔ | ✔ | ✔ | ✔ |
| Unit Enrolment | ✔ | ✔ | ✔ | ✔ |
| Course | ✔ | ✔ | ✔ | |
| Course Offer | ✔ | ✔ | ✔ | |
| Unit | ✔ | ✔ | ✔ | |
| Unit Offer | ✔ | ✔ | ✔ | |
| Record Custom Field | ✔ | ✔ | ||
| Event Session | ✔ | ✔ | ||
| Elearning Enrolment | ✔ | ✔ | ||
| Credential | ✔ | ✔ | ||
| Qualification Enrolment | ✔ | ✔ | ||
| Assessment Submission Data | ✔ |
