LearningSuite icon

LearningSuite

Interact with LearningSuite API (powered by agentur-systeme.de)

Actions100

Webhook → Get Webhook Sample Data

AI-generated

Summary

Retrieve sample webhook event data for a specified event type from the LearningSuite platform, optionally filtering by event-specific parameters to narrow the sample data returned.

Inputs

  • Sample Data Type (required) — Selects the type of sample webhook event data to retrieve (e.g., feedback events, course progress changes, exam completions, etc.).
  • AI Agent Limit Options — When Sample Data Type is 'AI Agent Limit for Inaccessible Course Content Exceeded Events', optionally filter by a specific agent ID.
  • Agent Action Executed Options — When Sample Data Type is 'Agent Action Executed Events', optionally filter by tool key and/or agent ID to limit the sample data.
  • Progress Changed Options — When Sample Data Type is 'Course Progress Changed Events', optionally filter by user ID and/or course ID.
  • Lesson Completed Options — When Sample Data Type is 'Lesson Completed Events', optionally filter by user ID, course ID, module ID, and/or lesson ID.
  • New Login Options — When Sample Data Type is 'New Login Events', optionally filter by user ID and/or login type.
  • Exam Completed Options — When Sample Data Type is 'Exam Completed Events', optionally filter by user ID.
  • Exam Graded Options — When Sample Data Type is 'Exam Graded Events', optionally filter by user ID.
  • Custom Popup Interaction Options — When Sample Data Type is 'Custom Popup Interaction Events', optionally filter by popup ID, user ID, and interaction type (dismissed or actioned).
  • Community Post Created Options — When Sample Data Type is 'Community Post Created Events', optionally filter by user ID, area ID, and/or forum ID.
  • Community Post Moderated Options — When Sample Data Type is 'Community Post Moderated Events', optionally filter by user ID, area ID, and/or forum ID.
  • Community Post Commented Options — When Sample Data Type is 'Community Post Commented Events', optionally filter by user ID and/or specific post ID.
  • Group User Access Changed Options — When Sample Data Type is 'Group User Access Changed Events', optionally filter by group ID and/or user ID.
  • Course Updated Options — When Sample Data Type is 'Course Updated Events', optionally filter by course instance ID.
  • Course Member Added Options — When Sample Data Type is 'Course Member Added Events', optionally filter by course instance ID.
  • User Activation Status Changed Options — When Sample Data Type is 'User Activation Status Changed Events', optionally filter by user ID and select action (activated or deactivated).
  • Custom Field Value Changed Options — When Sample Data Type is 'Custom Field Value Changed Events', optionally filter by custom field card ID and/or user ID.

Output shape

a single record representing example data of the chosen webhook event type

Returned sample data corresponds to the selected event type and applied filters; all filters are optional and applicable only for their respective event types. The shape of the sample data varies depending on the event. No pagination applies as this operation fetches sample data only.

Examples

Example 1: Retrieve a sample feedback event webhook payload

Sample Data Type set to 'Feedback Events' with no additional filters.

Example 2: Retrieve a sample lesson completed event filtered by a specific user and course

Sample Data Type set to 'Lesson Completed Events' and filtered by user ID and course ID options.

Links

Discussion