Skip to main content
Version: 0.18.3

Alerts

Alerts are designed to run an existing workflow on a schedule and alert you if specific criteria are met. For example, an alert might connect to your database and search for outliers every day and send you a text message if any are found.

Create an Alert​

You can use the Create skill to create a new alert. Specifically, use the following utterance format: Create an alert called <name> when <condition 1> <operator> <condition 2> on <days> at <time> <time zone> with the message <message>. You’re automatically subscribed to an alert when you create it.

Use the following parameters to create your alert:

  • Name (required). The name of the alert.
  • Condition 1 (required). For example, if you wanted to use the first row of the Age column in a dataset called Titanic, enter Titanic.1.Age. If you wanted to consider every row in the Age column individually, enter Titanic.any.Age.
  • Operator (required). The comparison operator to use between the Condition 1 and Condition 2 parameters.
  • Condition 2 (required). Another reference to a dataset (using the same format as Condition 1) or a numeric value.
  • Days (required). The days on which the alert should check the conditions.
  • Time (required). The time at which the alert should check the conditions on the given days. Note that this parameter uses a 24 hour (HH:MM) format.
  • Time zone (required). The time zone to use with the time parameter. The options include:
    • CST. Central Standard Time.
    • EST. Eastern Standard Time.
    • MST. Mountain Standard Time.
    • PST. Pacific Standard Time.
  • Message (optional). The message that should be sent to the recipient. This can be a combination of a string and a dataset reference. For example, if you wanted to include the age of the first passenger in the Titanic dataset, enter "The age of the first passenger is [Titanic.1.Age]." Note that you can't use "current" as the name of the dataset.

Delete an Alert​

You can use the Forget skill to delete an alert you created. You cannot delete alerts you don’t own. To delete an alert, enter Forget the alert called <name>.

Testing an Alert​

You can use the Test skill to test an alert you’ve created and make sure it’s functioning properly. To test an alert, enter Test the alert called <name>.

If the alert is working correctly, a success message appears in the chat history and a text message is sent if the condition is satisfied during the test. If the alert isn’t working, an error message appears in the chat history.

Manage Subscriptions​

You’re automatically subscribed to an alert when you create it. You can also subscribe users to your alert, unsubscribe users from your alert, and view all of the users subscribed to your alert.

To subscribe a user to your alert, enter Subscribe the user <email> to the alert called <name>. The selected user also receives a text message notifying them that they’ve been subscribed to the alert.

To unsubscribe a user from your alert, enter Unsubscribe the user <email> to the alert called <name>. The selected user also receives a text message notifying them that they’ve been unsubscribed from the alert.

To see all of the users subscribed to a given alert, enter List all subscribers to the alert called <name>.

Manage Schedules​

You can use the Reschedule skill to change the day and time at which an alert runs. You need to own the alert to change its schedule. To reschedule an alert, enter Reschedule the alert called <name> to <days> at <time> <time zone>.

View All Alerts​

You can use the List skill to see all of the alerts you’re subscribed to. This list includes alerts you’ve created and alerts created by others that you’ve been subscribed to.

To view these alerts, enter List all alerts.

View Logs​

Viewing an alert’s logs can be helpful during troubleshooting. You can view either the logs from the alert’s most recent run or all of the alert’s logs from when the alert was first created to the most recent run.

Logs can tell you when the alert ran, whether it ran successfully, whether it returned an error message, and whether a text message was sent successfully.

To view an alert’s logs, enter Show the logs for the alert called <name> from <limit>.

Use the following parameters when viewing an alert’s logs:

  • Name (required). The name of the alert.
  • Limit (required). How many logs to view. Enter either:
    • Every run. View all of the logs.
    • The latest run. View only the most recent logs.