Create environment alert (deprecated)

post/v1/environments/{environmentId}/alerts

Page View

Alert endpoints allow you to review or manage traffic alert rules, which monitor your integrations for healthy traffic. Learn about alerts.

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

Alert rule definitions

A No Traffic alert rule monitors whether traffic is flowing appropriately in a given subscription. For this type of alert, we send 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 30 minutes up to 72 hours). Since pending logs don't count as completed traffic, pending traffic could be a condition you define to trigger an alert. Failed logs do count as completed traffic, so this type of alert isn't for tracking errors.

An Error Threshold rule monitors the number of errors in a given subscription. 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).

You can retrieve an alert rule, as well as create, update, or delete it. Alternatively, you can retrieve a list of alert rules. An alert rule response contains details about any related subscription links.

You can also retrieve a subscription link for an alert rule, as well as create, pause, or delete it.

Create environment alert (deprecated)

Create a traffic alert rule for a specific environment within a Redox organization. You can specify the details for the traffic alert rule via API or the Redox dashboard (learn how to create a traffic alert rule in the dashboard).

This endpoint allows you to create one traffic alert rule at a time. To create multiple traffic alert rules, you can create your own script and programmatically create a batch of alerts in an environment.

This endpoint is deprecated. Use Create alert instead.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/alerts' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "name": "Org B PatientAdmin Alert",
8
  "dataFlowId": 8675309,
9
  "alertType": "no-traffic",
10
  "alertConfiguration": {
11
    "alertLookbackISODuration": "PT12H"
12
  },
13
  "notification": {
14
    "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
15
    "type": "email",
16
    "configuration": {
17
      "to": [
18
        "exampleEmail@example.com"
19
      ]
20
    }
21
  }
22
}'

Request Body Schema

name
required, string
Defines the name to assign to the new traffic alert rule.
dataFlowId
required, number
Contains the unique identifier of the data flow (i.e., subscription).
alertType
required, string
Specifies the type of new traffic alert rule. Currently, we support either No Traffic or Error Threshold types.
Possible Values: no-traffic, error-threshold

alertConfiguration

required,

One of:

Defines the conditions of a No Traffic alert rule, which monitors a data flow (i.e., subscription) for no completed traffic during a designated time frame.

alertLookbackISODuration

string

Specifies the ISO duration or time range that the traffic alert rule should evaluate for the trigger condition. For example, whether the condition is met in the most recent 2 hours.

notification
required, object
- id
  string
  Displays the unique identifier of this notification configuration.
  Format: uuid
- type
  string
  Defines the type of notification that's sent when a traffic alert rule is triggered. Currently, we only support email notifications.
  Value: email
- configuration
  object
  to
  Array of string
  Defines the list of email addresses that a notification is sent to whenever the traffic alert rule is either triggered or resolved. At least one email must be listed.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "alert": {
7
      "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
8
      "name": "Org B PatientAdmin Alert",
9
      "connectingOrg": {
10
        "id": 98765,
11
        "name": "Organization Name"
12
      },
13
      "dataFlow": {
14
        "id": 8675309,
15
        "source": {
16
          "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
17
          "name": "Redox"
18
        },
19
        "destination": {
20
          "id": "d710d1fd-15ef-4f84-9eab-16f03f9f5f87",
21
          "name": "Redox"
22
        },
23
        "dataModel": "PatientAdmin"
24
      },
25
      "alertType": {
26
        "code": "no-traffic"
27
      },
28
      "alertConfiguration": {
29
        "alertLookbackISODuration": "PT12H"
30
      },
31
      "latestStatus": {
32
        "code": "triggered",
33
        "timestamp": "2023-03-01T00:00:00.000Z"
34
      },
35
      "notification": {
36
        "id": "39a05bd3-cead-4707-a652-dd23bcb4fcbc",
37
        "type": "email",
38
        "configuration": {
39
          "to": [
40
            "exampleEmail@example.com"
41
          ]
42
        }
43
      },
44
      "creatingUser": {
45
        "id": 822,
46
        "name": "Abe Lincoln",
47
        "email": "abe.lincoln@redoxengine.com"
48
      }
49
    }
50
  }
51
}

meta
object
- version
  string
  Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
payload
object
- alert
  object
  Contains the details about the traffic alert rule.
  id
  string
  Displays the unique identifier of the new traffic alert rule.
  Format: uuid
  name
  string
  Displays the assigned name of the traffic alert rule.
  connectingOrg
  object
  Contains the details about the Redox organization associated with this log.
  id
  integer
  Identifies the specific Redox organization that you're operating in or on behalf of.
  name
  string
  Displays the human readable name of the Redox organization.
  dataFlow
  object
  Contains the details about the data flow, or subscription, that the traffic alert rule applies to.
  id
  number
  Displays the identifier of the specified subscription in the Redox organization.
  source
  object
  Contains the details about the system that initiates the data exchange in the subscription.
  id
  string
  Displays the unique identifier of the system that initiates the data exchange in the subscription.
  Format: uuid
  name
  string
  Displays the name of the system that initiates the data exchange in the subscription.
  destination
  object
  Contains the details about the intended endpoint of the subscription.
  id
  string
  Displays the unique identifier of the endpoint system in the subscription.
  Format: uuid
  name
  string
  Displays the name of the endpoint system in the subscription.
  dataModel
  string
  Identifies the data model being used to exchange data between systems.
  alertType
  object
  code
  string
  Displays one of two possible values that specify the type of traffic that the alert monitors, whether completed or failed traffic.
  Possible Values: no-traffic, error-threshold
  alertConfiguration
  Contains the required configuration fields for the specified type of traffic alert rule.
  One of:
  Defines the conditions of a No Traffic alert rule, which monitors a data flow (i.e., subscription) for no completed traffic during a designated time frame.
  alertLookbackISODuration
  string
  Specifies the ISO duration or time range that the traffic alert rule should evaluate for the trigger condition. For example, whether the condition is met in the most recent 2 hours.
  latestStatus
  object
  Contains the details of the most recent status of the traffic alert rule.
  code
  string
  Displays the most recent status of the traffic alert rule. The unknown status is often assigned if the alert is new or recently unpaused.
  Possible Values: triggered, okay, paused, unknown
  timestamp
  string
  Displays the date and time of the latest alert in ISO 8601 format.
  notification
  object
  id
  string
  Displays the unique identifier of this notification configuration.
  Format: uuid
  type
  string
  Defines the type of notification that's sent when a traffic alert rule is triggered. Currently, we only support email notifications.
  Value: email
  configuration
  object
  to
  Array of string
  Defines the list of email addresses that a notification is sent to whenever the traffic alert rule is either triggered or resolved. At least one email must be listed.
  creatingUser
  object
  Identifies the user that created the traffic alert rule.
  id
  number
  Displays the unique identifier of the user that created the traffic alert rule.
  name
  string
  Displays the name of the user that created the traffic alert rule.
  email
  string
  Displays the contact information, specifically the email address, of the user that created the traffic alert rule.

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®.