Lectful Central icon

Lectful Central

Interact with the Lectful Central API for admin operations

Actions63

Overview

This node interacts with the Lectful Central API to perform various administrative and operational tasks. Specifically, for the Health Checks resource with the Readiness Health Check operation, it checks if the Lectful Central application is ready to serve requests. This readiness check is useful in monitoring scenarios where you want to ensure that the application has completed its startup routines and is fully operational before routing traffic or performing further actions.

Practical examples include:

  • Automating deployment pipelines to verify service readiness before proceeding.
  • Integrating with monitoring tools to alert if the service is not ready.
  • Using in workflows that depend on the Lectful Central API being fully available.

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 (exclude /api/v1).
API Key Override Optional API key to override the stored credential's API key.

These properties control how the node authenticates with the Lectful Central API. For the readiness health check, no additional parameters are required.

Output

The node outputs an array of JSON objects, each representing the response from the Lectful Central API for the readiness health check.

  • The json field contains the parsed JSON response from the API endpoint /api/health-check/readiness.
  • The exact structure depends on the API but typically includes status indicators confirming the application's readiness state.
  • No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "status": "ready",
  "details": {
    "database": "connected",
    "services": "operational"
  }
}

Dependencies

  • Requires access to the Lectful Central API.
  • Authentication via either stored credentials configured in n8n or manual entry of Base URL and API key.
  • The node expects the API to expose a readiness health check endpoint at /api/health-check/readiness.
  • Network connectivity to the Lectful Central API server is necessary.

Troubleshooting

  • Missing or invalid credentials:
    If using stored credentials, ensure they are properly configured with a valid base URL and API key. If using manual mode, both Base URL Override and API Key Override must be provided. Errors will indicate missing or invalid credentials.

  • Base URL format errors:
    The Base URL should not include the /api/v1 suffix as the node appends this automatically when making requests.

  • API endpoint unreachable or timeout:
    Network issues or incorrect URLs can cause request failures. Verify the API server is reachable and the URL is correct.

  • Unexpected API responses:
    If the API returns non-JSON or error messages, the node may fail to parse the response. Check API logs or test the endpoint independently.

  • Common error message example:
    "Base URL Override is required when using Manual Configuration mode" — means the user did not provide the base URL while selecting manual authentication.

Links and References

Discussion