Przejdź do głównej zawartości

Webhooki

Rozszerzenia webhooków są wysyłane jako żądania POST na skonfigurowany adres URL webhooku.

Nagłówki:

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

Kształt ładunku najwyższego poziomu:

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

Dostawa, ponowne próby i zamawianie​

  • Webhooki są kolejkowane i dostarczane asynchronicznie w tle.
  • Dostawa wykorzystuje kolejkę opartą na Redisie z listą przetwarzania w trakcie realizacji, umożliwiającą odzyskiwanie danych po awarii.
  • Przetwarzanie odbywa się w sposób ciągły (około raz na sekundę na głównym serwerze roboczym).
  • Limit czasu HTTP na próbę wynosi ~3 sekundy.

Zasady ponawiania prób:

  • Próba dostarczenia przesyłki jest ponawiana, gdy:
  • żądanie przekroczyło limit czasu lub wystąpił błąd sieciowy
  • punkt końcowy zwraca 429
  • punkt końcowy zwraca dowolny status 5xx
  • Doręczenie nie jest ponawiane dla innych statusów 4xx.
  • Opóźnienia wycofywania to: 15s, 60s, 150s, 600s.

Konsekwencje dla integratorów:

  • Dostawa odbywa się przynajmniej raz, a nie dokładnie raz. Twój punkt końcowy powinien być idempotentny.
  • Kolejność jest ustalana z najwyższą starannością. Nie zakładaj ścisłej, globalnej kolejności dla wszystkich wydarzeń.
  • Zwróć szybką odpowiedź 2xx i przetwórz swoją dużą pracę asynchronicznie.
  • Jako klucza deduplikacji możesz użyć ładunku id.

Dane zdarzeń​

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

Uwagi:

  • requestedDeltaSeconds to żądana akcja.
  • appliedDeltaSeconds to kod, który został skutecznie zachowany.
  • appliedDeltaSeconds może być null, jeśli nie można go wywnioskować ze znaczników czasu wydania.

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

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

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

Uwagi:

  • source jest delete lub archive.
  • actorRole jest wearer lub keyholder.