VEverdun
camera-health

Notify Camera View Flag

E-mail the customer about a CONFIRMED flag (409 otherwise), one message per recipient, through the owner-e-mail path: 503 EMAIL_NOT_CONFIGURED while OWNER_EMAIL_ENABLED is off, 502 when no recipient was accepted. Records notified_at / notified_by_name / notify_summary only when at least one message went. Activity-logged with counts, never addresses.

post/camera-health/flags/{flag_id}/notify

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/camera-health/flags/{flag_id}/notify
  • Auth
    HTTP bearer

Path parameters

flag_idstring uuid required

Request body

recipientsstring[] required

Addresses to e-mail, 1-10 (one message each, no CC). Usually seeded from the item's contacts and edited by the operator; syntax-checked only.

subjectstring required

E-mail subject, 1-200 characters.

bodystring required

Plain-text e-mail body, 1-5000 characters. The newest checked frame is attached as a JPEG when it can be read.

Example request

{
  "recipients": [
    "facilities@example.com"
  ],
  "subject": "Camera view blocked at Harbor Yard - Back of Building Driveway",
  "body": "Hello, our monitoring team noticed something blocking the camera's view..."
}

Response

Successful Response

sentstring[] required

Recipients SES accepted.

rejectedstring[] required

Recipients SES rejected or could not confirm; do not assume these were delivered or undelivered.

Example response

{
  "flag": {
    "status": "open",
    "camera_label": "Back of Building Driveway",
    "site_name": "Harbor Yard",
    "site_timezone": "America/Chicago",
    "parent_name": "Sentinel Integrations",
    "kind": "web_or_insect",
    "coverage_pct": 40,
    "opening_checks": [
      {
        "light": "night",
        "kind": "web_or_insect",
        "coverage_pct": 40
      }
    ],
    "raise_count": 3,
    "checks_obstructed": 3,
    "checks_total": 4,
    "checks": [
      {
        "light": "night",
        "kind": "web_or_insect",
        "coverage_pct": 40
      }
    ],
    "recent_alarms": [
      {
        "incident_type": "INTRUSION",
        "outcome_label": "False alarm - no human activity"
      }
    ],
    "notify_summary": "Emailed 2 recipients",
    "contacts": [
      {
        "name": "Dana Ruiz",
        "role": "Facilities manager",
        "email": "facilities@example.com"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.