Skip to content
Tidepool API/Alerts API/
/
Create or update an alert...

Alerts API (1.0)

The Tidepool API is an HTTP REST API used by Tidepool clients to communicate with the Tidepool Platform.

For more information, see the Getting Started section.

Download OpenAPI description
alerts.v1.json
alerts.v1.yaml
Overview
URL

https://support.tidepool.org/

API Support

support@tidepool.org

License

BSD-2-Clause

Terms of Service

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/alerts.v1/

integration

https://external.integration.tidepool.org/

production

https://api.tidepool.org/

dev1

https://dev1.dev.tidepool.org/

qa1

https://qa1.development.tidepool.org/

qa2

https://qa2.development.tidepool.org/

Alerts

Endpoints related to alert configuration and management.

Operations

Delete an alerts configuration

Request

Delete an existing alerts configuration.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the user who granted follow access.

followerUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the care partner to receive alerts.

curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/alerts.v1/v1/users/{userId}/followers/{followerUserId}/alerts' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Get an alerts configuration

Request

Retrieve an existing alerts configuration.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the user who granted follow access.

followerUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the care partner to receive alerts.

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/alerts.v1/v1/users/{userId}/followers/{followerUserId}/alerts' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Alerts Config

Bodyapplication/json
non-empty
uploadIdstring(Upload ID)[ 17 .. 32 ] characters^([0-9a-f]{32}|upid_[0-9a-f]{12})$

An upload identifier; this field should be the uploadId of the corresponding upload record

Example: "0d92d5c1c22117a18f3620b9e24d3c06"
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

followedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

urgentLowobject

Blood glucose measurements at or below this value will trigger an immediate and urgent alert.

lowobject

Blood glucose measurements at or below this value will trigger an alert.

highobject

Blood glucose measurements at or above this value will trigger an alert.

noCommunicationobject

An alert sent when issues prevent the display of CGM data.

notLoopingobject

An alert sent when the Tidepool Loop app is unable to loop.

Response
application/json
{
  "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
  "userId": "string",
  "followedUserId": "string",
  "urgentLow": {
    "enabled": false,
    "threshold": { … }
  },
  "low": {
    "enabled": false,
    "delay": 0,
    "repeat": 0,
    "threshold": { … }
  },
  "high": {
    "enabled": false,
    "delay": 0,
    "repeat": 0,
    "threshold": { … }
  },
  "noCommunication": {
    "enabled": false,
    "delay": 0
  },
  "notLooping": {
    "enabled": false,
    "delay": 0
  }
}

Create or update an alerts configuration

Request

Create or update an alerts configuration. If no alerts configuration exists, it will be created.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the user who granted follow access.

followerUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of the care partner to receive alerts.

Bodyapplication/jsonrequired
non-empty
urgentLowobject

Blood glucose measurements at or below this value will trigger an immediate and urgent alert.

lowobject

Blood glucose measurements at or below this value will trigger an alert.

highobject

Blood glucose measurements at or above this value will trigger an alert.

noCommunicationobject

An alert sent when issues prevent the display of CGM data.

notLoopingobject

An alert sent when the Tidepool Loop app is unable to loop.

curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/alerts.v1/v1/users/{userId}/followers/{followerUserId}/alerts' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "urgentLow": {
      "enabled": false,
      "threshold": {
        "units": "mg/dL",
        "value": 105
      }
    },
    "low": {
      "enabled": false,
      "delay": 0,
      "repeat": 0,
      "threshold": {
        "units": "mg/dL",
        "value": 105
      }
    },
    "high": {
      "enabled": false,
      "delay": 0,
      "repeat": 0,
      "threshold": {
        "units": "mg/dL",
        "value": 105
      }
    },
    "noCommunication": {
      "enabled": false,
      "delay": 0
    },
    "notLooping": {
      "enabled": false,
      "delay": 0
    }
  }'

Responses

OK