Créer un seuil d'alerte

POST /alerts

Scope alerts:write
Clé API x-api-key
URL de base https://api.hub.akuasense.com/v1

L’alerte surveille l’humidité de la courbe de synthèse du module. L’utilisateur de la clé en est le premier destinataire. ⚠️ Seules les alertes portant un moduleId sont évaluées.

En-têtes

Idempotency-Key string

Rejoue la même réponse 2xx (24 h)

Corps de la requête

moduleId integer

Module à surveiller.
parcelId integer

Parcelle. ⚠️ Sans moduleId, l’alerte n’est jamais évaluée.
threshold number obligatoire

Seuil, en % d’humidité volumique.
hysteresis number

Marge de résolution, en points de %.

Par défaut : 5
reminderTime string

Heure LOCALE du rappel quotidien (HH:MM:SS), dans le fuseau de la société.

Par défaut : 08:00:00

Réponse

201

Alerte créée

id string uuid toujours présent
companyId integer toujours présent
moduleId integer peut être null toujours présent

Module surveillé.
parcelId integer peut être null toujours présent

Parcelle. ⚠️ Seules les mesures d’un module sont évaluées : une alerte sans moduleId ne se déclenche jamais.
annotationId string uuid peut être null toujours présent

Ligne « point de flétrissement » dont l’alerte est née (source: annotation). Déplacer la ligne déplace le seuil ; la supprimer désactive l’alerte.
threshold string toujours présent

Nombre décimal transmis en CHAÎNE, sans perte de précision ("11", "25.5625") : à convertir côté client.
hysteresis string toujours présent

Nombre décimal transmis en CHAÎNE, sans perte de précision ("11", "25.5625") : à convertir côté client.
reminderTime string toujours présent

Heure LOCALE du rappel quotidien (HH:MM:SS), dans le fuseau de la société (timezone de GET /company).
source string toujours présent

manual : créée directement (POST /alerts). annotation : née d’une ligne « point de flétrissement ».

Valeurs : manualannotation
isActive boolean toujours présent

false : désactivée, plus évaluée.
createdBy string toujours présent

Créateur : userId d’un membre.
createdAt string date-time toujours présent
updatedAt string date-time toujours présent
recipients tableau d’AlertRecipient toujours présent

L’utilisateur de la clé, créateur de l’alerte, en est d’office le premier destinataire.
Afficher les 3 attributs Masquer les attributs
- id string uuid toujours présent
- alertId string uuid toujours présent
- userId string toujours présent
  
  Destinataire des e-mails : userId d’un membre.

Erreurs

400
Saisie refusée

invalid_body
401
Non authentifié
403
Scope ou rôle insuffisant, ressource hors société, ou clé sans utilisateur

insufficient_scopeinsufficient_roleforbidden_resourceno_user

POST /alerts

curl -X POST https://api.hub.akuasense.com/v1/alerts \
  -H "x-api-key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "moduleId": 145,
    "threshold": 12,
    "reminderTime": "07:30:00"
  }'

const response = await fetch(
  'https://api.hub.akuasense.com/v1/alerts',
  {
    method: 'POST',
    headers: {
      'x-api-key': 'VOTRE_CLE_API',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "moduleId": 145,
      "threshold": 12,
      "reminderTime": "07:30:00"
    }),
  },
);
const data = await response.json();

import requests

response = requests.post(
    "https://api.hub.akuasense.com/v1/alerts",
    headers={"x-api-key": "VOTRE_CLE_API"},
    json={
        "moduleId": 145,
        "threshold": 12,
        "reminderTime": "07:30:00",
    },
)
data = response.json()

Réponse

{
  "id": "6f1d0b9e-2c4a-4e8b-9d3f-7a5c1e2b8d40",
  "companyId": 8,
  "moduleId": 145,
  "parcelId": null,
  "annotationId": null,
  "threshold": "12",
  "hysteresis": "5",
  "reminderTime": "07:30:00",
  "source": "manual",
  "isActive": true,
  "createdBy": "cmf8x2k4q0002js08h4m2c8kv",
  "createdAt": "2026-09-11T09:02:14.318Z",
  "updatedAt": "2026-09-11T09:02:14.318Z",
  "recipients": [
    {
      "id": "0b7e4c2a-9f13-4d6e-8a51-3c2f9e7d1b64",
      "alertId": "6f1d0b9e-2c4a-4e8b-9d3f-7a5c1e2b8d40",
      "userId": "cmf8x2k4q0002js08h4m2c8kv"
    }
  ]
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 400,
  "detail": "string",
  "code": "invalid_body"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · exemple généré depuis le schéma

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "insufficient_scope"
}

application/problem+json · exemple généré depuis le schéma