Start with Example Rules#
Apperate’s example rules are a great way to “test drive” real-time event processing and provide a starting point for creating rules to fit your needs. The Console Home provides shortcuts to the examples.
The Home page image above shows the following example rules:
Apple Price Alert Alerts you when Apple’s stock exceeds a specific price. You can for example, modify the rule to filter on a different stock and to trigger on the price you want.
Stock Screener Alerts you with potential stock picks based on fundamental and technical analysis measures. Tweak the conditions to screen for the kinds of stocks you want.
Microsoft Trade Alert Alerts you to Microsoft block trades. Change up the rule to filter on a stock that peaks your interest.
Choose an Example Rule#
Click Create Rule for any of the examples. The rule’s pre-populated summary page appears.
The image above shows the Apple Price Alert rule summary. The summary’s plain text describes the rule’s conditions and alert.
The rule is not yet created. You can finish creating it by clicking Create Rule or you can navigate to the other rule editor pages to examine (and possibly change) its conditions (page 1) and alerts (page 2).
If you want to start using the rule, skip to Activate the Rule. Otherwise, read on.
Modify the Rule#
To view the rule conditions, click 1 highlighted near the top of the page. The rule conditions page appears.
The image above shows the Apple Price Alert conditions. Here are some of the things you can do:
Modify the core stock condition’s symbol, fact, conditional, and or value to fit your use case
Add new conditions
Use the Any/All switch atop the form to specify whether the rule trigger requires all the conditions to be true or any of the conditions to be true
To view the rule outputs (alerts), click Go to Outputs or the 2 icon. The alert details page appears.
The image above shows the Apple Price Alert rule alerts page. Here are some things you can do:
Choose and configure the alert type to use
Set the wait time between alerts
Add other index values to include in the alert
Here are the alert types:
Webhook: Delivers a JSON object payload.
Google Cloud Function: Delivers a JSON object payload.
Dataset: Writes output to a dataset (creates it if it doesn’t already exist). Note, all columns except
Email: Delivers a data table with a set of values.
SMS: Sends a single-sentence update via text message.
Mattermost: Delivers a data table with a set of values.
Slack BETA: Delivers a data table with a set of values.
As new events meet your rule’s conditions, alerts are separated at least by the wait time between alerts.
Your alert can include core stock facts, core market facts, and facts from any of your custom events. Set the facts you want in the Additional Indexes section.
Activate the Rule#
When you’re ready to activate the rule, advance to the summary page and click Create Rule. Your rule activates and the Rules page appears with your rule.
The above image shows your rule and tracks the number of events passing and failing your conditions, the number of alerts sent, and more.
After an event passes, your rule sends an alert.
Examine the Alert#
The Apple Price Alert rule emails you.
The above image shows an example of the rule’s email. Here are some key things it includes:
Name of the rule that sent the alert
Event fact value that triggered the rule. The fact key is qualified by the
You can adjust the rule to include additional facts (indexes) or to use a different alert type, such as a webhook, Slack message, and more.
The example rules provide stepping stones to create production-ready rules for sending alerts to key stakeholders. Enjoy tyring all of the example rules and using them to implement no-code event handling logic!
Create Rules and Alerts - No Code tours you through creating rules on all supported fact types and describes all the alert options. You do all this in the Console–no code required.
Filter on Coinbase Events to act on cryptocurrency price changes.
Filter on Custom Dataset Events to alert on incoming data important to you.
Create Rules and Alerts Using the API demonstrates how to create rules using REST API endpoints.
Managing Rules Using the API shows you rule management via REST endpoints.