Lectful Central icon

Lectful Central

Interact with the Lectful Central API for admin operations

Actions63

Overview

The "Lectful Central" node integrates with the Lectful Central API to perform various administrative operations. Specifically, the Liveness Health Check operation under the Health Checks resource verifies if the application is alive and running. This check is useful in monitoring scenarios where you want to ensure that the Lectful Central service is operational and responsive.

Typical use cases include:

  • Automated monitoring workflows that periodically verify the health status of the Lectful Central system.
  • Triggering alerts or downstream processes if the service becomes unresponsive.
  • Integrating with uptime monitoring dashboards.

For example, a user might schedule this node to run every few minutes to confirm the Lectful Central API is live, helping maintain high availability and quick incident response.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful Central API:
- Use Stored Credentials
- Manual Configuration
Credentials Note Informational note shown when using Manual Configuration mode explaining credential usage.
Base URL Override Optional base URL to override the stored credential's base URL (excluding /api/v1).
API Key Override Optional API key to override the stored credential's API key.

These properties allow flexible authentication setup either by using pre-configured credentials or manual input of API endpoint and key.

Output

The node outputs an array of JSON objects representing the API response from the liveness health check endpoint. The structure depends on the API but typically includes status information indicating whether the service is alive.

Example output JSON might look like:

{
  "status": "ok",
  "timestamp": "2024-06-01T12:00:00Z"
}

No binary data is produced by this operation.

Dependencies

  • Requires access to the Lectful Central API.
  • Needs either stored API credentials configured in n8n or manual entry of the base URL and API key.
  • Network connectivity to the Lectful Central API endpoint.
  • No additional external libraries beyond standard HTTP request helpers provided by n8n.

Troubleshooting

  • Missing or invalid credentials: If neither stored credentials nor manual overrides are properly set, the node will throw an error indicating missing authentication details. Ensure credentials are correctly configured or manual fields are filled.
  • Base URL Override required in manual mode: When using manual configuration, the base URL must be provided; otherwise, an error is thrown.
  • API key required in manual mode: Similarly, the API key override must be supplied in manual mode.
  • Timeouts or network errors: The node uses a 10-second timeout for the health check request. Network issues or incorrect URLs may cause failures.
  • Invalid JSON response: If the API returns a string instead of JSON, the node attempts to parse it. Failure to parse will keep the raw string as output.

To resolve these issues:

  • Verify credentials and manual inputs.
  • Confirm network access to the API.
  • Check the API documentation for correct endpoint usage.

Links and References

Discussion