Overview
This node, named "FloodGuard," acts as a protective filter to control message floods within workflows. It is designed to help maintain workflow efficiency by preventing excessive or rapid message sending that could overwhelm systems or violate rate limits.
Typical use cases include:
- Throttling messages sent to chat platforms to avoid spamming.
- Ensuring compliance with messaging service rate limits.
- Acting as a gatekeeper in automation flows where message frequency needs regulation.
For example, when integrated into a messaging workflow, it can check if a message should be allowed based on recent activity and block or delay messages that exceed configured thresholds.
Properties
| Name | Meaning |
|---|---|
| ChatId | Identifier of the chat where the message is being sent. |
| PhoneNumberId | Identifier related to the phone number involved (optional). |
| MessageId | Identifier of the specific message (optional). |
| Message | The content of the message to be checked or processed by the flood guard. |
Output
The node outputs JSON data containing a single field:
stdout: A trimmed string returned from an external flood control client process. This output likely indicates the result of the flood check, such as whether the message is allowed or blocked.
No binary data output is produced by this node.
Dependencies
- The node depends on an external executable located at
/opt/flood_guard/bin/flood_client. This executable is called with parameters derived from the input properties. - The environment where n8n runs must have this executable installed and accessible with appropriate permissions.
- No direct API keys or external web services are required, but system-level configuration for the flood guard client is necessary.
Troubleshooting
Common issues:
- The external flood guard client executable may not be installed or accessible at the expected path.
- Insufficient permissions to execute the flood guard client.
- Unexpected errors or output from the flood guard client indicating internal failures.
Error messages:
"FloodGuard internal error: <error message>"— Indicates the flood guard client returned an error message on standard error. Check the client logs or configuration."FloodGuard failed to execute. Please check system configuration."— Indicates failure to run the external client, possibly due to missing executable or permission issues.
To resolve these errors:
- Verify the flood guard client is installed at
/opt/flood_guard/bin/flood_client. - Ensure the n8n process user has execution rights.
- Review any logs or documentation for the flood guard client for further diagnostics.
Links and References
- No direct links available from the source code.
- For more information, consult the documentation or support resources of the external flood guard client used by this node.