Audiobookshelf icon

Audiobookshelf

Work with the Audiobookshelf API

Overview

This node integrates with the Audiobookshelf API to retrieve information about users currently online or active playback sessions. It is useful for monitoring user activity in an audiobook library environment, such as displaying which users are listening right now or tracking ongoing playback sessions.

Practical examples include:

  • Displaying a dashboard of users currently online.
  • Monitoring active audiobook playback sessions for analytics or support purposes.

Properties

Name Meaning
Return Choose what data to return:
- Users: Returns users that are currently online.
- Sessions: Returns currently playing playback sessions.

Output

The node outputs JSON data containing either:

  • A list of users who are currently online, including relevant user details.
  • A list of active playback sessions, detailing which audiobooks are being played and by whom.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Audiobookshelf API.
  • The node expects the base URL of the Audiobookshelf instance to be configured via credentials.
  • No additional external dependencies beyond the Audiobookshelf API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API authentication token will cause authorization errors.
    • Invalid or unreachable domain URL in credentials can lead to connection failures.
    • Selecting an unsupported combination of resource and operation may result in no data returned.
  • Error messages:

    • Authorization errors typically indicate invalid or expired API keys; verify and update credentials.
    • Network errors suggest connectivity problems; check the domain URL and network access.
    • Empty responses might mean no users are currently online or no active sessions exist.

Links and References

Discussion