İçeriğe geç

Olaylar

Olaylar uçları: parametreler, alanlar ve örnek yanıtlar.

Geliştirici belgesi

Olay akışını okur

GET /api/v1/events

Kapsam: events:read

Hesabın olayları, sırayla. Gövde incedir (kimlik, durum, gün); ayrıntı ilgili kaynağın ucundan okunur. Yalnız hesap geneli anahtar okuyabilir. Anahtar yalnız görebildiği olayları alır: kaynak kapsamı isteyen tür (çalışan, birim, izin, vardiya, çizelge) o kapsamı da ister; her tür, modülü hesapta açıksa ve anahtarın rolü o modülü görebiliyorsa gelir. Hekim uygunluğu türünün günleri izinden türer: leave:read kapsamını da ister ve izin modülü açık, rol izinleri görebiliyor olmalıdır. Görünmeyen olay atlanır: sequence değerleri arasındaki boşluk arada görünmeyen olayların toplam sayısını söyler, türünü söylemez. Sayfalar next_cursor ile okunur; son sayfadan sonra son görülen sequence değeri after ile gönderilerek sürdürülür. Olaylar 30 gün saklanır, sıra garantisi yoktur: id ile tekilleştirin. Bir istek sınırlı sayıda sırayı tarar: sayfa kısa ya da boş gelebilir; next_cursor doluysa okumayı sürdürün. Türü gizli izin talebinin olayında tür boş gelir, "belge bekliyor" pending, ret iptal olayı olarak görünür.

Parametreler

events.list: Parametreler
AlanTürAçıklama
after (sorgu)stringYalnız sequence değeri bundan büyük olaylar. Verilmezse saklanan en eski olaydan başlar.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

events.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunluOlayın kimliği; tekilleştirme bununla yapılır.
sequenceintegerzorunluHesap içinde artan sıra.
typestringzorunluOlay türü (olay kataloğu). Değerler: employee.created, employee.updated, employee.started, employee.terminated, org_unit.changed, leave.request.created, leave.request.approved, leave.request.rejected, leave.request.cancelled, overtime.request.approved, shift.plan.published, shift.assignment.changed, roster.published, roster.assignment.changed, physician.availability.changed, payroll.period.approved, expense.claim.approved, signature.envelope.completed, recruiting.application.hired, approval.task.created
occurred_atstring (date-time)zorunlu
company_idstring (uuid)zorunlunull olabilirOlayın şirketi; şirketi olmayan olayda null.
subjectobjectzorunluOlayın konusu: kaynak türü ve kimliği.
actor_kindstringzorunluOlayı yazan bağlamın türü (user, system, apikey gibi); kim olduğu yazılmaz.
payloadobjectzorunluTürün ince gövdesi: kimlik, durum, gün. Ad, tutar ve serbest metin taşımaz.
Örnek yanıt
{
  "data": [
    {
      "id": "6f5e4d3c-2b1a-4c9d-8e7f-6a5b4c3d2e1f",
      "sequence": 4182,
      "type": "leave.request.approved",
      "occurred_at": "2026-06-16T08:05:00.412Z",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "subject": {
        "type": "leave_request",
        "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f"
      },
      "actor_kind": "user",
      "payload": {
        "leave_request_id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
        "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
        "leave_type_id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
        "start_date": "2026-07-06",
        "end_date": "2026-07-10",
        "status": "approved"
      }
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout