The formo alerts command group lets you manage project alerts. Alerts notify you when specific events or thresholds are triggered.
List all alerts for the project.
Requires alerts:read scope on your API key.
Get a single alert by ID.
Requires alerts:read scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
alertId | string | ✅ | Alert ID |
formo alerts get alert_abc123
Create a new project alert.
Requires alerts:write scope on your API key.
Options
| Option | Type | Required | Description |
|---|
--name | string | ✅ | Alert name |
--triggerType | string | ✅ | Trigger type (e.g. event, threshold) |
--triggerFilters | string | ❌ | JSON array of trigger filter objects |
--recipient | string | ❌ | JSON array of recipient objects |
--secret | string | ❌ | Webhook secret for the alert |
Examples
# Create a basic event alert
formo alerts create --name "High value tx" --triggerType event
# Create an alert with trigger filters and recipients
formo alerts create \
--name "Whale activity" \
--triggerType threshold \
--triggerFilters '[{"field":"net_worth_usd","op":"gt","value":100000}]' \
--recipient '[{"type":"email","value":"team@example.com"}]'
# Create an alert with a webhook secret
formo alerts create \
--name "Transaction webhook" \
--triggerType event \
--secret "whsec_abc123"
Update an existing alert.
Requires alerts:write scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
alertId | string | ✅ | Alert ID to update |
Options
| Option | Type | Required | Description |
|---|
--name | string | ❌ | Alert name |
--triggerType | string | ❌ | Trigger type |
--triggerFilters | string | ❌ | JSON array of trigger filter objects |
--recipient | string | ❌ | JSON array of recipient objects |
--secret | string | ❌ | Webhook secret for the alert |
Examples
# Update an alert name
formo alerts update alert_abc123 --name "Renamed alert" --triggerType event
# Update alert with new recipients
formo alerts update alert_abc123 \
--name "Updated alert" \
--triggerType threshold \
--recipient '[{"type":"slack","value":"#alerts"}]'
Delete an alert.
Requires alerts:write scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
alertId | string | ✅ | Alert ID to delete |
formo alerts delete alert_abc123
Deleting an alert is permanent.
Toggle an alert’s status between active and paused.
Requires alerts:write scope on your API key.
Arguments
| Argument | Type | Required | Description |
|---|
alertId | string | ✅ | Alert ID to toggle |
Options
| Option | Type | Required | Description |
|---|
--status | enum | ✅ | New status: active or paused |
Examples
# Pause an alert
formo alerts toggle alert_abc123 --status paused
# Re-activate an alert
formo alerts toggle alert_abc123 --status active
