Zum Hauptinhalt springen

Webhooks

Extension-Webhooks werden als POST-Anfragen an Ihre konfigurierte Webhook-URL gesendet.

Überschriften:

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

Nutzlastform auf oberster Ebene:

{
  "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
  }
}

Lieferung, Wiederholungsversuche und Bestellung​

  • Webhooks werden in eine Warteschlange gestellt und asynchron im Hintergrund zugestellt.
  • Die Zustellung nutzt eine Redis-gestützte Warteschlange mit einer Liste laufender Verarbeitungsvorgänge zur Wiederherstellung nach einem Absturz.
  • Die Verarbeitung läuft kontinuierlich (etwa einmal pro Sekunde auf dem primären Worker).
  • Das HTTP-Timeout pro Versuch beträgt ca. 3 Sekunden.

Wiederholungsrichtlinie:

  • Eine Zustellung wird wiederholt, wenn:
  • Die Anfrage ist abgelaufen oder es ist ein Netzwerkfehler aufgetreten.
  • Der Endpunkt gibt 429 zurück.
  • Der Endpunkt gibt einen beliebigen 5xx-Status zurück.
  • Bei anderen 4xx-Status wird die Zustellung nicht wiederholt.
  • Backoff-Verzögerungen sind: 15s, 60s, 150s, 600s.

Auswirkungen für Integratoren:

  • Die Zustellung erfolgt mindestens einmal, nicht genau einmal. Ihr Endpunkt sollte idempotent sein.
  • Die Reihenfolge erfolgt nach bestem Wissen und Gewissen. Gehen Sie nicht von einer strikten globalen Reihenfolge für alle Veranstaltungen aus.
  • Senden Sie eine schnelle 2xx-Antwort und verarbeiten Sie Ihre eigenen rechenintensiven Aufgaben asynchron.
  • Sie können die Nutzlast id als Deduplizierungsschlüssel verwenden.

Ereignisdaten​

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
  }
}

Anmerkungen:

  • requestedDeltaSeconds ist die angeforderte Aktion.
  • appliedDeltaSeconds ist das, was effektiv gespeichert wurde.
  • appliedDeltaSeconds kann null sein, wenn es nicht aus den Veröffentlichungszeitstempeln abgeleitet werden kann.

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
  }
}

task.*-Ereignisse​

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"
  }
}

hygiene.*-Ereignisse​

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"
  }
}

Anmerkungen:

  • source ist entweder delete oder archive.
  • actorRole ist entweder wearer oder keyholder.