Alerts
View alert templates and create, update, list, or delete Faurya goal email alerts from the CLI.
Alerts
Alert commands manage goal-triggered email alerts for one website.
Alert template reference
Use the template reference command to see supported template variables and default templates for the website.
faurya alerts template-reference <websiteId>List alerts
faurya alerts list <websiteId>Create an alert
alerts create requires a recipient and one or more goal events. It accepts canonical public fields:
| Field | Required | Details |
|---|---|---|
alertName | No | Human-readable name. |
goalEvents | Yes | Array of 1 to 20 goal event names. |
recipientEmail | Yes | Email address receiving notifications. |
enabled | No | Boolean enabled state. |
emailSubject | No | Subject template. |
emailBody | No | Body template. |
faurya alerts create <websiteId> --input '{"alertName":"Signup alert","goalEvents":["signup"],"recipientEmail":"alerts@example.com","enabled":true}'You can use --name for the alert name.
faurya alerts create <websiteId> --name "Signup alert" --input '{"goalEvents":["signup"],"recipientEmail":"alerts@example.com"}'Update an alert
alerts update requires <alertId> and at least one changed field.
faurya alerts update <websiteId> <alertId> --input '{"enabled":false}'faurya alerts update <websiteId> <alertId> --input '{"goalEvents":["signup","purchase"],"recipientEmail":"alerts@example.com"}'Delete an alert
Deleting an alert is destructive and requires confirmation unless --yes is supplied.
faurya alerts delete <websiteId> <alertId>faurya alerts delete <websiteId> <alertId> --yesEnabled and disabled states
Set enabled to true for active alerts and false to keep an alert configured but inactive.
faurya alerts update <websiteId> <alertId> --input '{"enabled":true}'faurya alerts update <websiteId> <alertId> --input '{"enabled":false}'Recipient requirements
Recipients must be valid email addresses. Use distribution lists or shared inboxes only if your organization allows them.
Confirmation behavior
Only alerts delete is destructive. In a non-interactive shell, use --yes after checking the website ID and alert ID.
Deleting an alert removes the alert configuration for the selected website. Disable an alert instead if you may need it later.