Skip to main content

Webhookit

Laajennuswebhookit lähetetään POST-pyyntöinä määritettyyn webhook-URL-osoitteeseesi.

Ylätunnisteet:

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

Ylimmän tason hyötykuorman muoto:

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

Toimitus, uudelleenyritykset ja tilaaminen​

  • Webhookit jonotetaan ja toimitetaan asynkronisesti taustalla.
  • Toimitus käyttää Redis-tuettua jonoa ja käynnissä olevaa käsittelyluetteloa kaatumisen jälkeistä palautusta varten.
  • Käsittely tapahtuu jatkuvasti (noin kerran sekunnissa ensisijaisessa työasemassa).
  • HTTP-aikakatkaisu yritystä kohden on ~3 sekuntia.

Uudelleenyrityskäytäntö:

  • Toimitusta yritetään uudelleen, kun:
  • pyyntö aikakatkaistaan ​​tai siinä on verkkovirhe
  • päätepiste palauttaa 429
  • päätepiste palauttaa minkä tahansa 5xx-tilan
  • Toimitusta ei yritetä uudelleen muissa 4xx-tiloissa.
  • Peruutusviiveet ovat: 15s, 60s, 150s, 600s.

Integraattoreiden vaikutukset:

  • Toimitus tapahtuu ainakin kerran, ei täsmälleen kerran. Päätepisteesi tulisi olla idempotentti.
  • Järjestys on parhaan kykymme mukainen. Älä oleta tarkkaa globaalia järjestystä kaikissa tapahtumissa.
  • Palauta nopea 2xx-vastaus ja käsittele oma raskas työsi asynkronisesti.
  • Voit käyttää hyötykuormaa id deduplikaatioavaimena.

Tapahtumatiedot​

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

Huomautuksia:

  • requestedDeltaSeconds on pyydetty toiminto.
  • appliedDeltaSeconds säilyi käytännössä.
  • appliedDeltaSeconds voi olla null, jos sitä ei voida johtaa julkaisun aikaleimoista.

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.*-tapahtumat​

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.*-tapahtumat​

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

Huomautuksia:

  • source on delete tai archive.
  • actorRole on wearer tai keyholder.