Hanna Bot

Interact with Hanna IRC Bot via its REST API

Overview

The Hanna Bot node allows interaction with an IRC bot via its REST API, enabling various IRC-related operations such as sending messages, joining or leaving channels, retrieving user or channel information, and more. This node is useful for automating IRC communications, managing IRC channels, monitoring IRC server status, and integrating IRC functionalities into workflows.

Practical examples include:

  • Automatically sending announcements or alerts to specific IRC channels.
  • Joining or parting from IRC channels based on workflow triggers.
  • Fetching detailed user or channel information for monitoring or logging purposes.
  • Changing the bot's nickname dynamically.
  • Sending raw IRC commands for advanced control.

Properties

Name Meaning
Target IRC channel (e.g., #general) or username to target. Used when sending messages, notices, joining, or parting channels.

Note: The "Target" property applies specifically to the operations: send message, send notice, join channel, and part channel.

Output

The node outputs a JSON object containing:

  • success: Boolean indicating if the operation was successful.
  • operation: The performed operation name.
  • response: The raw response data from the Hanna Bot API, parsed as JSON.
  • timestamp: ISO string timestamp of when the operation was executed.

Additional fields depend on the operation; for the Join Channel operation specifically:

  • channel: The IRC channel joined (same as the "Target" input).

For other operations, the output may include details such as message content, user info, channel info, statistics, errors, etc.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Hanna Bot REST API.
  • The node expects the Hanna Bot API URL and token to be configured in the credentials.
  • Network access to the Hanna Bot REST API endpoint is necessary.

Troubleshooting

  • Invalid Operation Error: If an unsupported operation is specified, the node throws an error indicating "Invalid operation". Ensure the operation parameter is set correctly.
  • Authentication Failures: Errors related to authorization usually mean the API token is missing, invalid, or expired. Verify the API key credential configuration.
  • Network Issues: Timeouts or connection errors indicate network problems or incorrect API URL settings.
  • Malformed Responses: If the API returns unexpected data, parsing errors might occur. Check the Hanna Bot server status and API version compatibility.
  • Missing Required Parameters: For example, the "Target" field is required for join operations. Make sure all required inputs are provided.

Links and References

Discussion