Update link

patch/v2/environments/{environmentId}/alertLinks/{alertLinkId}

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.

Update link

Update an existing link for an alert rule within a Redox organization. You must use the correct ID to update the settings.

Only for engineer or support roles

Any user in an environment may view alert rules and alert history. However, you must be assigned to an engineer or a support role to manage alerts. Learn about roles.

Alert rules aren't available for free Redox accounts, so they won't be visible in the dashboard or available via API. You must upgrade your Redox account to use alert rules.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v2/environments/{environmentId}/alertLinks/{alertLinkId}' \
2
--request PATCH \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
  "assignment": {
8
    "id": "1ee1d994-652f-44b5-9342-4b3e8b9918ee",
9
    "kind": "alert"
10
  },
11
  "subscription": {
12
    "id": "8675309"
13
  },
14
  "status": "active"
15
}'

Path Parameters

environmentId
required, string
Identifies the specific environment that you're operating in or on behalf of.
alertLinkId
required, string
Contains the unique identifier of the alert link.

Request Body Schema

Contains the fields that you can populate when updating an existing alert link.

assignment
object
Specifies the alert this link is assigned to.
- id
  string
  Contains the unique identifier of the alert.
- kind
  string
  Identifies what kind of link is assigned.
  Value: alert
subscription
object
The subscription to assign to the alert link.
- id
  number
  Contains the unique identifier of subscription.
status
Indicates whether to activate or pause the alert link. If "active", the related alert rule will be monitored, so alerts and notifications may be triggered. If "paused", the alert rule won't be monitored, so no alerts or notifications will be triggered.
Possible Values: active, paused

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "alertLink": {
7
      "id": "dc5d2a43-df19-459c-b14f-450584ce1c55",
8
      "assignment": {
9
        "id": "1ee1d994-652f-44b5-9342-4b3e8b9918ee",
10
        "kind": "alert"
11
      },
12
      "subscription": {
13
        "id": "8675309",
14
        "dataModel": "PatientAdmin",
15
        "source": {
16
          "id": "1ee1d994-652f-44b5-9342-4b3e8b9918ee",
17
          "name": "string"
18
        },
19
        "destination": {
20
          "id": "39a858ea-4474-4d04-b37e-88862fe4054d",
21
          "name": "string"
22
        },
23
        "serviceRegion": "AWS_USA_EAST_1"
24
      },
25
      "connectingOrganization": {
26
        "id": 122,
27
        "name": "string"
28
      },
29
      "latestStatus": {
30
        "code": "triggered",
31
        "timestamp": "2024-04-28T19:17:16.719Z"
32
      },
33
      "environment": {
34
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
35
      },
36
      "createdAt": "2024-04-25T18:17:16.719Z",
37
      "createdBy": {
38
        "id": 0,
39
        "name": "string",
40
        "email": "string"
41
      },
42
      "updatedAt": "2024-04-25T18:17:16.719Z",
43
      "updatedBy": {
44
        "id": 0,
45
        "name": "string",
46
        "email": "string"
47
      }
48
    }
49
  }
50
}

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
- alertLink
  object
  Contains an alert link and its related details.
  id
  string
  Displays the unique identifier of the link for a specified alert.
  Format: uuid
  assignment
  object
  Specifies the alert this link is assigned to.
  id
  string
  Contains the unique identifier of the alert.
  kind
  string
  Identifies what kind of link is assigned.
  Value: alert
  subscription
  object
  Identifies the subscription that the alert is linked to.
  id
  number
  Contains the unique identifier of subscription.
  dataModel
  string
  Identifies the Redox data model that the link applies to.
  source
  object
  Specifies the source of the subscription that the alert is linked to.
  id
  string
  Contains the unique identifier of the source.
  name
  nullable, string
  Displays the human-readable name of the source.
  destination
  object
  Specifies the destination of the subscription that the alert is linked to.
  id
  string
  Contains the unique identifier of the destination.
  name
  nullable, string
  Displays the human-readable name of the destination.
  serviceRegion
  string
  Identifies the region that the subscription is operating in.
  Possible Values: AWS_USA_EAST_1, AWS_CAN_CENTRAL, GCP_USA_CENTRAL_1
  connectingOrganization
  object
  Specifies the organization the asset is connected to when the subscription relates to a partner organization.
  id
  number
  Contains the unique identifier of the Redox organization.
  name
  nullable, string
  Contains the human-readable name of the Redox organization.
  latestStatus
  object
  Contains the code and timestamp for the current status of the alert for this link.
  code
  string
  Describes the current status of the alert.
  Possible Values: triggered, okay, paused, unknown
  timestamp
  string
  Contains date and time for the current status update.
  environment
  object
  Contains metadata about the environment within the associated Redox organization.
  id
  string
  Contains the unique identifier of the Redox environment.
  Format: uuid
  createdAt
  string
  Displays the date and time that the asset was originally created in ISO 8601 format.
  createdBy
  object
  Contains the metadata about the user who created the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.
  updatedAt
  string
  Displays the date and time that the asset was last updated in ISO 8601 format.
  updatedBy
  object
  Contains the metadata about the user who last updated the asset.
  id
  number
  Contains the unique identifier of the user.
  name
  nullable, string
  Displays the user's full name.
  email
  nullable, string
  Displays the user's email address.

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