Create Rules and Alerts - No Code#
Prerequisite
IEX Cloud Apperate account - Create one here.
Creating rules in the Console is easy.
Go to the Console in your browser.
Next to Rules in the navigation, click the
+icon to start creating a rule.
The conditions form appears.
Set Your Conditions#
The conditions page is where you specify the event characteristics to trigger notifications on.
For example, you could send an alert when a specific stock’s price changes 5% AND its PE Ratio is under 15. The animated GIF in Processing Events demonstrates that use case.
Step 1 - Specify the entity to check#
Use the Workspace and Namespace selectors, to locate the entity.
The image above shows the CORE workspace; it represents IEX Cloud Data. You can trigger alerts on STOCK conditions and US MARKET conditions.
Workspace Overview:
Workspace |
Namespace |
Entities |
|---|---|---|
CORE |
MARKET |
US market facts |
CORE |
STOCKS |
Symbols |
(YOUR WORKSPACE) |
DATASET |
Datasets in your workspace |
Drill down into the workspaces and namespaces to find an entity for your condition.
For CORE stocks, you can select a specific stock or select the top option ANYEVENT - Any symbol to apply the condition to all available symbols.
To create rules for events related to your custom datasets, select (YOUR_WORKSPACE) → DATASET.
Step 2 - Specify a condition to check on the entity#
Here’s where you declare an entity condition to trigger on.
Conceptually, entity conditons read like this …
Entity:Fact Conditional Value
Example:
AAPL:LastestPrice 'is above' 150
Select a Fact and a Conditional, and then enter a Value to compare with; or another data point to compare with.
If you have more conditions to specify, click Add condition and repeat the steps above.
Step 3 - Select “any” or “all” to qualify your condition set#
If you have multiple conditions, use the top slider to set the rule to trigger alerts either when …
Any of the conditions are met
All the conditions are met
If you’re done adding conditions, click Go to Outputs. The alerts/outputs page appears.
Configure Alerts#
The alerts/outputs page allows you to configure
Alert type and frequency
Data to embed in the alert
Step 1 - Choose an Alert Type#
Use different alert types to get data where you need it and in the format you want.
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 timestamp are strings.
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.
Choose your alert type and then fill in the details for sending the alert.
Make sure to set the wait time between alerts. As new events meet your rule’s conditions, alerts will at least be separated by the wait time.
Important
You can write event data constantly without delay to a dataset if you set output to Dataset and set Wait time … to zero (0). Wait time for all other output types must be at least 1 minute.
Warning
Chaining rules that output to and filter on the same dataset can lead to writing the same data multiple times to the same dataset.
Step 2 - Embed data points in your alert#
You can pass along any data points you have access to, including data points outside of your conditions. The data points you specify will be included in the alert message.
For example, the image below shows a configuration of oil prices and DuPont’s lastest price and next earnings.
Click Go to Summary when you’re done configuring the alert.
Confirm Your Rule#
The summary shows your rule’s name and articulates your rule in human-readable form.
Name your rule and then click Create Rule to launch it.
The dashboard shows your rule–it’s active and running!
To pause your rule, click Pause. You can un-pause it by toggling the same button.
The dashboard displays all your rules. In it you can pause and un-pause rules, and click a rule’s edit button to view and edit the rule.
Additional Resources#
(Video) Tutorial: Connect to Coinbase and Write a Rule
Filter on Custom Dataset Events
Create Rules and Alerts Using the API