メインコンテンツまでスキップ

ウェブフック

拡張機能のウェブフックは、POSTリクエストとして、設定済みのウェブフックURLに送信されます。

見出し:

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

最上位ペイロード形状：

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

配送、再試行、および注文​

  • Webhookはキューに格納され、バックグラウンドで非同期的に配信されます。
  • 配信機能は、クラッシュからの復旧のために、処理中のリストを備えたRedisをバックエンドとするキューを使用します。
  • 処理は継続的に実行されます（プライマリワーカーでは約1秒に1回）。
  • HTTPタイムアウトは1回の試行につき約3秒です。

再試行ポリシー:

  • 配送が再試行されるのは、以下の場合です。
  • リクエストがタイムアウトしたか、ネットワークエラーが発生しました
  • エンドポイントは429を返します
  • エンドポイントは、5xx ステータスを返します。
  • その他の4xxステータスの場合、配送は再試行されません。
  • バックオフ遅延は、15s、60s、150s、600s です。

システムインテグレーターへの影響：

  • 配信は少なくとも1回行われるべきであり、正確に1回とは限りません。エンドポイントは冪等性を持つ必要があります。
  • 順序付けは最善の努力に基づくものです。すべてのイベントにおいて厳密な全体的な順序付けが保証されるとは限りません。
  • 高速な2xxレスポンスを返し、自身の重い処理を非同期で実行してください。
  • ペイロードidを重複排除キーとして使用できます。

イベントデータ​

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

注記:

  • requestedDeltaSecondsが、要求されたアクションです。
  • 実際に永続化されたのはappliedDeltaSecondsです。
  • リリースタイムスタンプから導き出せない場合、appliedDeltaSecondsはnullとなる可能性があります。

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.*イベント​

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.*イベント​

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

注記:

  • sourceはdeleteまたはarchiveです。
  • actorRoleはwearerまたはkeyholderです。