Everest icon

Everest

Interact with Everest TMS (Transport Management System)

Alert → Create

AI-generated

Overview

This node operation creates an alert in the Everest Transport Management System (TMS). It is useful for notifying users or clients about important events or statuses, such as invoice payments, warnings, or informational messages. For example, it can be used to generate a success alert when an invoice is paid or a warning alert for pending actions.

Use Case Examples

  1. Create a success alert with an icon and message for a client when an invoice is paid.
  2. Generate a warning alert with a URL redirect for unread alerts in the system.

Properties

Name Meaning
Icon Icon identifier for the alert, used to visually represent the alert type.
Category Alert category indicating the type of alert such as success, warning, danger, or info.
Text The alert message text that describes the alert content.
Created For The target for the alert, specifying the platform or client ID to whom the alert is directed.
Additional Fields Optional additional fields for the alert such as URL for redirection when the alert is clicked and status indicating if the alert is read or unread.

Output

JSON

  • id - Unique identifier of the created alert.
  • icon - Icon identifier used in the alert.
  • category - Category of the alert (success, warning, danger, info).
  • text - Text message of the alert.
  • created_for - Target entity for whom the alert was created.
  • url - Optional URL for redirection when the alert is clicked.
  • status - Status of the alert indicating if it is read or unread.

Dependencies

  • Requires an API key credential for Everest TMS to authenticate requests.

Troubleshooting

  • Common issues include missing required fields such as icon, category, text, or created_for which will cause the operation to fail.
  • Errors related to authentication usually indicate invalid or missing API credentials.
  • If the alert creation fails, verify the target identifier format (e.g., 'client:123') and ensure the API endpoint is reachable.

Discussion