Actions55
- Client Actions
- General Actions
- Mission Actions
- Agent Actions
- Invoice Actions
- Contact Actions
- Alert Actions
- Walter Actions
- Notification Actions
- Webhook Actions
- Route Actions
- Export Actions
Overview
The node integrates with the Everest Transport Management System (TMS) to retrieve multiple alert records based on specified criteria. It is useful for scenarios where users need to monitor, filter, or analyze alerts generated by the system, such as tracking unread notifications or searching for specific alert content.
Practical examples include:
- Fetching the latest 50 alerts to display in a dashboard.
- Retrieving only unread alerts to notify users of pending issues.
- Searching alerts containing specific keywords to investigate incidents.
Properties
| Name | Meaning |
|---|---|
| Options | Collection of optional parameters to customize the alert retrieval: |
| - Limit | Maximum number of alert results to return (default 50). |
| - Limit Start | Starting offset for pagination, zero-based index (default 0). |
| - Search | Text string to filter alerts by content; requires minimum 3 characters. |
| - Status | Filter alerts by their read status; options are: All (no filter), Unread, or Read. |
Output
The node outputs an array of JSON objects representing alert records retrieved from Everest TMS. Each object corresponds to an alert and contains its details as provided by the API.
If the node supports binary data output (not indicated here), it would typically represent attachments or files related to alerts, but this node focuses on JSON alert data.
Dependencies
- Requires an API key credential for authenticating requests to the Everest TMS API.
- The node depends on the Everest API endpoints to fetch alert data.
- No additional external services or environment variables are explicitly required beyond the API authentication.
Troubleshooting
Common Issues:
- Providing a search term shorter than 3 characters will likely result in no filtering or an error.
- Exceeding the maximum allowed limit or invalid pagination offsets may cause API errors.
- Network or authentication failures can prevent data retrieval.
Error Messages:
- Errors returned from the API will be surfaced as messages in the node's output if "Continue On Fail" is enabled.
- Authentication errors indicate missing or invalid API credentials; verify the configured API key.
- Validation errors on input parameters suggest adjusting the "Limit", "Limit Start", or "Search" values according to API requirements.
Links and References
- Everest TMS official documentation (for API details and alert data structure)
- n8n documentation on creating and using custom nodes
- General REST API best practices for pagination and filtering