Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node integrates with the Lectful API to manage various aspects of an online learning platform. Specifically, for the Progress resource and the Mark Lecture Complete operation, it allows users to mark a specific lecture as completed. This is useful in scenarios where you want to track learner progress programmatically, such as automatically marking lectures complete after certain triggers or integrating progress updates into other workflows.

Practical examples:

  • Automatically mark a lecture as complete when a user finishes watching a video.
  • Sync lecture completion status from another system into Lectful.
  • Trigger follow-up actions (like awarding certificates) once a lecture is marked complete.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API:
- Use Stored Credentials
- Manual Configuration (provide Base URL and API key manually)
Credentials Note Informational note shown only when using Manual Configuration mode about credential usage.
Base URL Override Optional base URL to override the stored credential's base URL (without /api/v1).
API Key Override Optional API key to override the stored credential's API key.
Lecture ID The ID of the lecture to mark as complete (required).

Output

The node outputs the JSON response returned by the Lectful API after marking the lecture as complete. This typically includes confirmation details about the completion status of the lecture for the user.

The output structure is:

{
  "json": {
    // API response data confirming lecture completion
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored credentials configured in n8n or manual input of the Lectful API base URL and API key.
  • The API key must have permissions to update progress (mark lectures complete).
  • No additional external dependencies beyond HTTP requests to the Lectful API.

Troubleshooting

  • Missing or invalid credentials:
    Error if neither valid stored credentials nor manual configuration with both Base URL and API key are provided.
    Resolution: Configure credentials properly or provide manual overrides.

  • Lecture ID not provided or invalid:
    The operation requires a valid lecture ID. Missing or incorrect IDs will cause API errors.
    Resolution: Ensure the Lecture ID parameter is set correctly.

  • API request failures:
    Network issues, invalid API keys, or insufficient permissions can cause errors.
    Resolution: Verify network connectivity, API key validity, and permission scopes.

  • Unexpected API responses:
    If the API returns unexpected data or error messages, check the Lectful API documentation and ensure the node parameters match expected values.

Links and References

Discussion