LearningSuite icon

LearningSuite

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

Overview

This node interacts with the LearningSuite API to retrieve sample webhook data of various event types. Specifically, for the "Webhook" resource and the "Get Webhook Sample Data" operation, it fetches example payloads representing different kinds of webhook events that LearningSuite can emit.

This is useful when setting up or testing webhook integrations, allowing users to preview the structure and content of webhook events without needing actual live events to occur. For example, a user might want to see what data is sent when a community post is created or when an exam is graded, enabling them to configure downstream workflows accordingly.

Practical examples:

  • Previewing the JSON payload of a "Feedback Event" to map fields in subsequent nodes.
  • Testing how your workflow handles "New Login Events" by retrieving sample data.
  • Understanding the structure of "Lesson Completed Events" for reporting purposes.

Properties

Name Meaning
Sample Data Type The type of sample webhook event data to retrieve. Options include:
- Community Post Created Events
- Community Post Moderated Events
- Custom Popup Interaction Events
- Exam Completed Events
- Exam Graded Events
- Feedback Events
- Group User Access Changed Events
- Lesson Completed Events
- New Login Events
- Progress Changed Events

Output

The node outputs an array of JSON objects representing the sample webhook event data corresponding to the selected sample data type. Each object contains the typical fields and values that would be present in a real webhook payload for that event.

If the node supports binary data output (not indicated here), it would typically represent attachments or media related to the webhook event, but this node focuses on JSON sample data only.

Dependencies

  • Requires a valid API key credential for the LearningSuite API.
  • The node uses the base URL and authentication details configured in the credentials.
  • No additional external services are required beyond access to the LearningSuite API.

Troubleshooting

  • No handler error: If you select a resource-operation combination not supported, the node will throw an error indicating no handler exists. Ensure you select "Webhook" as the resource and "Get Webhook Sample Data" as the operation.
  • Authentication errors: If the API key or base URL is incorrect or missing, the node will fail to retrieve data. Verify your API credentials and connection settings.
  • Invalid sample data type: Selecting a sample data type not recognized by the API may cause errors or empty results. Use one of the predefined options listed in the properties.
  • Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error messages alongside input data for failed items.

Links and References

Discussion