Create a traffic alert rule

Last updated: Nov 16, 2023

We offer proactive monitoring for your organization in the Redox dashboard using traffic alert rules. When you create a traffic alert rule and the conditions of the rule are met in your system, we send an email to the designated users.

There are two types of traffic alert rules: No Traffic or Error Threshold.

Redox recommendations

We recommend using No Traffic alert rules if you want to make sure traffic is flowing like it should. One alert rule applies to one subscription in a given environment. This type of alert rule triggers a notification if no logs reach a terminal state (i.e., Succeeded, Filtered, or Failed) in a specified amount of time (i.e., as little as 2 hours up to 72 hours). Pending logs don't count as completed traffic, so that could be a condition to trigger this alert. But remember that since failed logs count as completed traffic, this type of alert rule isn't for tracking errors.

We recommend using Error Threshold rules if you want to address traffic errors in a given environment. This type of alert rule triggers a notification if X number of logs reach a terminal state of Failed and will no longer be retried within a specified time (i.e., as little as 15 minutes up to 24 hours).

Traffic alert rules notify you about irregularities so you don't have to constantly check the dashboard yourself. Bonus, you can independently monitor the health of your integration without relying on Redox support.

Free Redox accounts

Traffic alert rules aren't available for free dashboard organizations. If you have a free Redox account, the Monitoring page displays a message that this feature is unavailable. To create and monitor alerts, you must upgrade your Redox account.

These instructions are for creating one traffic alert rule at a time. If you want to create multiple traffic alert rules, you can create your own script and programmatically create a batch of alerts in an environment using the Platform API.

Only for engineer or support roles

Not all users in a given environment may view or edit traffic alert rules. You must be assigned to an engineer or a support role to view and manage alerts and alert history. Learn about roles.

Log in to the Redox dashboard.
From the navigation menu, click the Monitoring page.
By default, the Traffic Alert Rules tab opens and displays any configured alerts. You can search for, filter, and see the latest status of any configured alerts for the current environment.
Available environment types and connections
If you don't see an option for creating a traffic alert rule, you may have selected the wrong environment type, or the selected environment doesn't have any configured connections.
If you're in a development environment, you may see a message like the one below. Make sure to select either a staging or production environment.
If you don't have any connections in the selected staging or production environment, you may see a message like the one below. Double check you're in the right environment, or request a new connection for the environment first.
To create a new alert rule, click the Create Rule button.
The Create New Alert page opens. Select the options for the Connection Scope section.
- Connection: Select the connection you want to create a rule for.
- Subscription: Click the Select Subscription link to open the dialog with all the subscription options for the connection you selected. You can also use the search bar to locate the subscription you're looking for or page through the options using the FIRST, PREV, NEXT, and LAST buttons.
Next, select the options for the Alert Settings and Alert Name section.
- Alert Type: Select either No Traffic or Error Threshold. Depending on which you select, you also must populate the fields that appear for time or number of errors.
  Allowable number of alert types
  You may only create one alert of a given type for the specified subscription. In other words, there can't be two No Traffic alerts or two Error Threshold alerts for the same subscription.
- In the Alert Name section, enter a descriptive name for the new alert.
In the Notifications section, you can choose who should be notified when an alert is triggered. Enter the email address(es) that should receive the alert notification. Use commas to separate email addresses if the alert notification should go to more than one address.
Click the Create Rule button to save the new alert.
Programmatic option
You can also use the Platform API to create a traffic alert rule. Or, you can build your own script to programmatically create a batch of traffic alert rules for a given environment using the Platform API, too.
The Alert Rules tab opens again and displays the new alert. You can click on the alert to expand and view the details like the alert type and time window, along with the name of the user that created the rule. If you're the creator of the alert rule or an organization owner, you can also edit, pause, or delete the alert.
Traffic alert rule details and options
Redox evaluates every 15 minutes for Error Threshold alerts or every 30 minutes for No Traffic alerts. Whenever the conditions of the alert are met, Redox sends an email to the specified list of email addresses. The email includes the alert type with a link to view the related logs. The specified users also receive an email when an alert has been cleared.
Redox email address
The alert notification is sent from alerts@redoxengine.com. Make sure to allow-list that email address as a sender, or check your spam folder if the alert notification doesn't show up in your inbox.
Getting removed from the email list
Only the alert creator or an organization owner can modify the email notification list. If a user wants to stop receiving the email notifications, they must work with either of those persons to remove their email address from the alert notification list.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.