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
This node integrates with the Everest Transport Management System (TMS) to create alerts within the platform. It allows users to generate alert notifications targeted at specific platforms or clients, which can be used to inform users about important events such as invoice statuses, warnings, or informational messages.
Common scenarios include:
- Notifying a client that an invoice is awaiting payment.
- Alerting a user or system about a warning or error condition.
- Providing informational messages related to transport or logistics operations.
Practical example:
- Creating a "Success" category alert with an icon representing invoices, targeted at a specific client, with a message like "Invoice awaiting payment". When clicked, it could redirect the user to the relevant invoice page.
Properties
| Name | Meaning |
|---|---|
| Icon | Icon identifier for the alert (e.g., "invoice") |
| Category | Alert category; options: Success, Warning, Danger, Info |
| Text | Alert message text (the main content of the alert) |
| Created For | Target for the alert, specified as either a platform or a client ID (e.g., "client:123") |
| Additional Fields | Optional additional fields: |
| - URL | URL to redirect when the alert is clicked (e.g., "/client/invoices") |
| - Status | Alert status; options: 0 for unread, 1 for read |
Output
The node outputs a JSON array where each element represents the result of creating an alert. The structure of each output item corresponds to the created alert's data returned by the Everest API. This typically includes details such as the alert ID, category, text, target, status, and any other metadata provided by the API.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the Everest TMS API.
- The node uses the Everest API endpoints internally to perform alert creation.
- Proper configuration of the Everest API credentials in n8n is necessary.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrectly formatted "Created For" values may lead to errors if the target platform or client ID does not exist.
- Providing invalid category or status values outside the allowed options will cause validation errors.
Error messages:
- Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.
- Validation errors: Check that all required fields are filled and that option values match the allowed choices.
- Network or API errors: Verify network connectivity and that the Everest API service is operational.
Links and References
- Everest TMS official documentation (not provided here, but recommended to consult for detailed API usage)
- n8n documentation on creating custom nodes and using credentials