Functions
send core
fn (alert: Alert)
fn (channel: Str, data: Map)
fn (channel: Str)
Send an alert on a channel with optional data.
Alerts are used to notify users or external systems about important events. The alert will be recorded in history, and if any subscriptions match the channel pattern, notifications will be delivered to configured destinations (email, Slack, PagerDuty, webhooks).
Arguments
channel: String - The alert channel name (e.g., "payment:failed", "deploy:custom")data: Map (optional) - Additional data to include with the alert
Returns
- Result with alert ID on success, or error message on failure
Example
// Send a simple alert
::hot::alert/send("user:high-value-signup", {
"user_id": user.id,
"plan": "enterprise",
"value": 50000
})
// Send an alert for a custom deployment step
::hot::alert/send("deploy:database-migration", {
"migration": "add_users_table",
"status": "completed",
"duration_ms": 1523
})
// Send using an Alert value
alert Alert("deploy:rollback", {"reason": "health check failed"})
::hot::alert/send(alert)
Channel Naming
Use a colon-separated naming convention: category:event
payment:failed- Payment processing faileduser:created- New user signed updeploy:rollback- Deployment was rolled backcustom:my-event- Custom application events
Subscriptions To receive alerts, create subscriptions in the Hot Cloud dashboard:
- Create a destination (email, Slack, etc.)
- Create a channel pattern to match your alert names
- Create a subscription linking the channel to the destination
Local Development
Alerts are a Hot Cloud feature. In local dev (hot dev / hot run),
send is a no-op that returns a success result so your code continues
without error. Alerts are only delivered when running in a deployed
environment.
Types
Alert
fn (channel: Str, data: Map): Alert
Alert type {
channel: Str,
data: Map
}