Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.formo.so/llms.txt

Use this file to discover all available pages before exploring further.

The formo alerts command group lets you manage project alerts. Alerts notify you when specific events or thresholds are triggered.

​
formo alerts list

List all alerts for the project.
Requires alerts:read scope on your API key.
formo alerts list

​
formo alerts get

Get a single alert by ID.
Requires alerts:read scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
alertIdstring✅Alert ID
formo alerts get alert_abc123

​
formo alerts create

Create a new project alert.
Requires alerts:write scope on your API key.

​
Options

OptionTypeRequiredDescription
--namestring✅Alert name
--trigger-typestring✅Trigger type (e.g. event, threshold)
--trigger-filtersstring❌JSON array of trigger filter objects
--recipientstring❌JSON array of recipient objects
--secretstring❌Webhook secret for the alert

​
Examples

# Create a basic event alert
formo alerts create --name "High value tx" --trigger-type event

# Create an alert with trigger filters and recipients
formo alerts create \
  --name "Whale activity" \
  --trigger-type threshold \
  --trigger-filters '[{"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" \
  --trigger-type event \
  --secret "whsec_abc123"

​
formo alerts update

Update an existing alert.
Requires alerts:write scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
alertIdstring✅Alert ID to update

​
Options

OptionTypeRequiredDescription
--namestring❌Alert name
--trigger-typestring❌Trigger type
--trigger-filtersstring❌JSON array of trigger filter objects
--recipientstring❌JSON array of recipient objects
--secretstring❌Webhook secret for the alert

​
Examples

# Update an alert name
formo alerts update alert_abc123 --name "Renamed alert" --trigger-type event

# Update alert with new recipients
formo alerts update alert_abc123 \
  --name "Updated alert" \
  --trigger-type threshold \
  --recipient '[{"type":"slack","value":"#alerts"}]'

​
formo alerts delete

Delete an alert.
Requires alerts:write scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
alertIdstring✅Alert ID to delete
formo alerts delete alert_abc123
Deleting an alert is permanent.

​
formo alerts toggle

Toggle an alert’s status between active and paused.
Requires alerts:write scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
alertIdstring✅Alert ID to toggle

​
Options

OptionTypeRequiredDescription
--statusenum✅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