Get alert by id

get/v1/organizations/{organizationId}/{environment}/alerts/{alertId}

Page View

The Alerts category contains endpoints to review or manage traffic alert rules, which monitor your integrations for healthy traffic. There are two types of traffic alert rules: No Traffic or Error Threshold.

We recommend using No Traffic alert rules if you want to know if traffic is actually flowing like it should in a given environment. This type of alert rule triggers a notification if a specified data flow hasn't had any logs reach a terminal state (i.e., Succeeded, Filtered, or Failed) in a designated amount of time (i.e., as little as 15 minutes up to 24 hours). If a log is pending, it doesn't count as completed traffic, so pending logs could be a condition of triggering this alert. But also keep in mind that since failed logs count as completed traffic, this type of alert rule doesn't necessarily help you track 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 have reached a terminal state of Failed and will no longer be retried within a given period of time (i.e., as little as 15 minutes up to 24 hours).

You can retrieve a specific alert or a list of existing traffic alert rules or a specific alert rule, as well as create, update, or delete a traffic alert rule.

Get alert by id

This query allows you to retrieve one specific traffic alert rule based on the unique alert identifier. This may be helpful if you want to review an alert before updating or deleting it.

Request parameters

Path Parameters

organizationId
required, string
Displays the unique identifier of the Redox dashboard organization where the traffic alert rule is applied.
environment
required, string
Identifies the specific environment that the traffic alert rule is operating in.
alertId
required, string
Displays the unique identifier of the traffic alert rule. This identifier can't be modified once the alert is created.

Select example

cURL request example

1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/{environment}/alerts/{alertId}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

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 dashboard organization associated with this log.
  id
  integer
  Displays the unique identifier of the dashboard organization.
  name
  string
  Displays the name of the dashboard organization.
  dataFlow
  object
  Contains the details about the data flow that the traffic alert rule applies to.
  id
  number
  Displays the identifier of the specified data flow in the Redox dashboard organization.
  source
  object
  Contains the details about the system that initiates the data exchange in the data flow.
  id
  string
  Displays the unique identifier of the system that initiates the data exchange in the data flow.
  Format: uuid
  name
  string
  Displays the name of the system that initiates the data exchange in the data flow.
  destination
  object
  Contains the details about the intended endpoint of the data flow.
  id
  string
  Displays the unique identifier of the endpoint system in the data flow.
  Format: uuid
  name
  string
  Displays the name of the endpoint system in the data flow.
  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 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®.