Skip to content
IoT OS

Read an alert

GET
/integration/v1/organizations/{organization}/alerts/{uuid}
curl --request GET \
  --url https://api.elwids.xyz/api/integration/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/alerts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Requires: alerts:read

Rate limits: 240 a minute per address, 60 a minute per application

404 when the alert’s device is not granted to the application.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization
required
string format: uuid

The organization UUID. A value that does not match returns 404.

uuid
required
string format: uuid

A value that does not match returns 404.

Responses

Section titled “Responses”

200

Section titled “200”

The alert.

Media typeapplication/json
object
data
required

A snapshot of one alert episode. The same object is the data of the alert.*.v1 events.

object
uuid
required
string format: uuid
episode
required
integer
>= 1
condition
required
string
Allowed values: active cleared
activated_at
required
string | null format: date-time
cleared_at
required
string | null format: date-time
acknowledged_at
required
string | null format: date-time
workflow_uuid
required
string format: uuid
workflow_name
required
string
device_uuid
required
string format: uuid
execution_stopped_reason
required

Why the alert’s workflow stopped evaluating, for example binding_changed.

string | null

Example 

{
  "data": {
    "uuid": "7c9e2a41-1d3b-4f5e-8a6c-2b4d6f8a0c1e",
    "episode": 3,
    "condition": "cleared",
    "activated_at": "2026-10-12T07:58:10.000000Z",
    "cleared_at": "2026-10-12T08:20:45.000000Z",
    "acknowledged_at": "2026-10-12T08:02:00.000000Z",
    "workflow_uuid": "5a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "workflow_name": "North paddock — Herd tracker 17",
    "device_uuid": "3f8a1c2e-5b6d-4e7f-8a9b-0c1d2e3f4a5b",
    "execution_stopped_reason": null
  }
}

Headers

Section titled “Headers”
Cache-Control
required
string
/(^|[ ,])no-store([ ,]|$)/

Responses to authenticated integration requests are never cached. The header also carries private.

Example 
no-store, private

401

Section titled “401”

No valid credentials: no session (first-party API), or a missing, invalid, expired or revoked application token (integration API).

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

403

Section titled “403”

The caller is not allowed: not a member of the organization, missing a tenant or platform permission, or (integration API) an ability not granted on both the application and the token.

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

404

Section titled “404”

Not found: an unknown organization or resource, a resource in another organization or not granted to the application, or a malformed identifier (the route does not match).

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

429

Section titled “429”

A rate limit was reached; see x-rate-limits on the operation.

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

Headers

Section titled “Headers”
Retry-After
required
integer

Seconds to wait before retrying.

Report a problem with this page