Aller au contenu principal

Webhooks

Les webhooks d'extension sont envoyés sous forme de requêtes POST à l'URL de webhook configurée.

En-têtes :

  • Content-Type: application/json
  • x-webhook-event: <event-name>
  • x-webhook-token-hash: <sha256-hash>

Forme de la charge utile de niveau supérieur :

{
  "id": "uuid",
  "event": "lock.time_changed",
  "eventData": {},
  "timestamp": "2026-02-16T01:23:45.678Z",
  "app": {
    "id": "app_id",
    "slug": "my-app",
    "displayName": "My App"
  },
  "sessionId": "extension_session_id",
  "extension": {
    "sessionId": "extension_session_id",
    "enabled": true,
    "config": {}
  },
  "wearer": {
    "id": "wearer_user_id",
    "username": "wearer_name"
  },
  "keyholder": {
    "id": "keyholder_user_id",
    "username": "keyholder_name"
  },
  "lock": {
    "id": "lock_id",
    "title": "Lock title",
    "releaseAt": "2026-02-20T00:00:00.000Z",
    "remainingSeconds": 12345,
    "isLocked": true,
    "isFrozen": false
  }
}

Livraison, nouvelles tentatives et commandes​

  • Les webhooks sont mis en file d'attente et livrés de manière asynchrone en arrière-plan.
  • Delivery utilise une file d'attente Redis avec une liste de traitement en cours pour la récupération en cas de panne.
  • Le traitement s'exécute en continu (environ une fois par seconde sur le nœud de calcul principal).
  • Le délai d'attente HTTP par tentative est d'environ 3 secondes.

Politique de nouvelle tentative :

  • Une livraison est relancée lorsque :
  • La requête a expiré ou une erreur réseau s'est produite.
  • Le point de terminaison renvoie 429
  • le point de terminaison renvoie tout état 5xx
  • Une livraison n'est pas retentée pour d'autres statuts 4xx.
  • Les délais d'attente sont : 15s, 60s, 150s, 600s.

Implications pour les intégrateurs :

  • La livraison a lieu au moins une fois, et non pas exactement une seule fois. Votre point de terminaison doit être idempotent.
  • Le classement est effectué au mieux. Veuillez ne pas présumer d'un classement global strict pour tous les événements.
  • Renvoie une réponse 2xx rapide et traite tes propres tâches lourdes de manière asynchrone.
  • Vous pouvez utiliser la charge utile id comme clé de déduplication.

Données d'événement​

lock.time_changed​

{
  "event": "lock.time_changed",
  "eventData": {
    "source": "keyholder",
    "beforeReleaseAt": "2026-02-20T00:00:00.000Z",
    "afterReleaseAt": "2026-02-20T01:00:00.000Z",
    "requestedDeltaSeconds": 3600,
    "appliedDeltaSeconds": 3600
  }
}

Remarques :

  • requestedDeltaSeconds correspond à l'action demandée.
  • appliedDeltaSeconds est ce qui a effectivement été conservé.
  • appliedDeltaSeconds peut être null s'il ne peut pas être déduit des horodatages de publication.

lock.frozen / lock.unfrozen​

{
  "event": "lock.frozen",
  "eventData": {
    "source": "keyholder",
    "durationSeconds": 3600,
    "beforeFrozen": false,
    "afterFrozen": true
  }
}
{
  "event": "lock.unfrozen",
  "eventData": {
    "source": "dice",
    "durationSeconds": 900,
    "beforeFrozen": true,
    "afterFrozen": false
  }
}

Événements task.*​

task.assigned​

{
  "event": "task.assigned",
  "eventData": {
    "runId": "tr_1739665200000",
    "taskId": "task_123",
    "status": "active",
    "source": "keyholder",
    "overriddenRunId": null
  }
}

task.completed​

{
  "event": "task.completed",
  "eventData": {
    "runId": "tr_1739665200000",
    "taskId": "task_123",
    "status": "completed",
    "pointsAwarded": 10
  }
}

task.failed​

{
  "event": "task.failed",
  "eventData": {
    "runId": "tr_1739665200000",
    "taskId": "task_123",
    "status": "failed",
    "penaltyApplied": true,
    "outcomeDescription": "1 hour added"
  }
}

Événements hygiene.*​

hygiene.started​

{
  "event": "hygiene.started",
  "eventData": {
    "startedAt": "2026-02-16T02:00:00.000Z",
    "expiresAt": "2026-02-16T02:30:00.000Z",
    "windowSeconds": 1800,
    "penaltySeconds": 3600
  }
}

hygiene.resumed​

{
  "event": "hygiene.resumed",
  "eventData": {
    "completedAt": "2026-02-16T02:20:00.000Z",
    "lateMinutes": 0,
    "penaltyApplied": false,
    "punishmentSeconds": 0,
    "penaltyMode": null,
    "cardsAdjusted": 0,
    "actualDeltaSeconds": null
  }
}

hygiene.resumed_late​

{
  "event": "hygiene.resumed_late",
  "eventData": {
    "completedAt": "2026-02-16T02:45:00.000Z",
    "lateMinutes": 15,
    "penaltyApplied": true,
    "punishmentSeconds": 3600,
    "penaltyMode": "time",
    "cardsAdjusted": 0,
    "actualDeltaSeconds": 3600
  }
}

verification.picture_submitted​

{
  "event": "verification.picture_submitted",
  "eventData": {
    "verificationId": "verification_id",
    "date": "2026-02-16",
    "submittedAt": "2026-02-16T03:10:00.000Z",
    "photoUrl": "https://cdn.example.com/locks/..."
  }
}

dice.rolled​

{
  "event": "dice.rolled",
  "eventData": {
    "userTotalScore": 14,
    "botTotalScore": 8,
    "difference": 6,
    "requestedAdjustmentSeconds": -3600,
    "appliedAdjustmentSeconds": -3600,
    "cardGameEnabled": false
  }
}

lock.archive_removal​

{
  "event": "lock.archive_removal",
  "eventData": {
    "source": "archive",
    "actorRole": "wearer",
    "lockId": "lock_id"
  }
}

Remarques :

  • source est delete ou archive.
  • actorRole est wearer ou keyholder.