Olay kataloğu
Webhook ve olay akışındaki her olay türü, gövde alanları ve gereken kapsam.
Geliştirici belgesi
Bu sayfa webhook'ların ve olay akışının (GET /api/v1/events) taşıdığı her olay türünü listeler. Liste ürünün olay kataloğundan derlemede üretilir.
- Bir olayı okumak için anahtarda türün kapsamı bulunmalıdır.
events:readisteyen türler ayrıca türün modülünün hesapta açık olmasını ve rolün o modülde hesabın tamamını görmesini ister. - Gövde incedir: kimlik, durum, gün ve ay taşır. Ayrıntıyı ilgili uçtan okuyun.
- Takvimde gizli bir izin türünde
leave_type_idboş gelir ve durum yalnız görünen hâldir: belge bekleyen taleppending, reddedilen talepcancelledgörünür. - Yeni olay türü ve yeni bir tür için yeni alan eklenebilir; var olan bir türün alanı kaldırılmaz ve türü değişmez.
Olay türleri
employee.created
Çalışan kaydı açıldı (ekrandan, Excel aktarımıyla ya da işe alımdan).
Kapsam: employees:read · Modül: Personel
| Alan | Tür |
|---|---|
employee_ | kimlik (uuid) |
org_ | kimlik (uuid), null olabilir |
status | durum: active, pre_start, inactive, terminated |
hire_ | gün (YYYY-MM-DD), null olabilir |
employee.updated
Çalışan kaydı değişti. Gövde yalnız değişen alanların adını taşır.
Kapsam: employees:read · Modül: Personel
| Alan | Tür |
|---|---|
employee_ | kimlik (uuid) |
changed_ | alan adları: first_name, last_name, work_email, org_unit_id, job_title_id, position_id, manager_id, hire_date, service_start_date, sgk_entry_date, employment_type, probation_end |
employee.started
İlk iş günü gelen çalışan aktif oldu.
Kapsam: employees:read · Modül: Personel
| Alan | Tür |
|---|---|
employee_ | kimlik (uuid) |
start_ | gün (YYYY-MM-DD) |
employee.terminated
Çalışanın işten çıkışı kaydedildi. Çıkış nedeni gövdede yoktur.
Kapsam: employees:read · Modül: Personel
| Alan | Tür |
|---|---|
employee_ | kimlik (uuid) |
last_ | gün (YYYY-MM-DD) |
org_unit.changed
Birim açıldı, güncellendi, taşındı ya da silindi.
Kapsam: org:read · Modül: Organizasyon
| Alan | Tür |
|---|---|
org_ | kimlik (uuid) |
parent_ | kimlik (uuid), null olabilir |
change | durum: created, updated, moved, removed |
leave.request.created
İzin talebi açıldı.
Kapsam: leave:read · Modül: İzin
| Alan | Tür |
|---|---|
leave_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
leave_ | kimlik (uuid), null olabilir |
start_ | gün (YYYY-MM-DD) |
end_ | gün (YYYY-MM-DD) |
status | durum: awaiting_document, pending, approved, rejected, cancelled |
leave.request.approved
İzin talebi onaylandı.
Kapsam: leave:read · Modül: İzin
| Alan | Tür |
|---|---|
leave_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
leave_ | kimlik (uuid), null olabilir |
start_ | gün (YYYY-MM-DD) |
end_ | gün (YYYY-MM-DD) |
status | durum: awaiting_document, pending, approved, rejected, cancelled |
leave.request.rejected
İzin talebi reddedildi.
Kapsam: leave:read · Modül: İzin
| Alan | Tür |
|---|---|
leave_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
leave_ | kimlik (uuid), null olabilir |
start_ | gün (YYYY-MM-DD) |
end_ | gün (YYYY-MM-DD) |
status | durum: awaiting_document, pending, approved, rejected, cancelled |
leave.request.cancelled
İzin talebi iptal edildi (bekleyen talep geri çekildi ya da onaylı izin iptal edildi).
Kapsam: leave:read · Modül: İzin
| Alan | Tür |
|---|---|
leave_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
leave_ | kimlik (uuid), null olabilir |
start_ | gün (YYYY-MM-DD) |
end_ | gün (YYYY-MM-DD) |
status | durum: awaiting_document, pending, approved, rejected, cancelled |
overtime.request.approved
Fazla mesai talebi onaylandı (kendiliğinden onay dahil). Süre gövdede yoktur.
Kapsam: events:read · Modül: Fazla mesai
| Alan | Tür |
|---|---|
overtime_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
work_ | gün (YYYY-MM-DD) |
shift.plan.published
Vardiya planının ayı yayımlandı ya da çizelge yayımıyla yenilendi.
Kapsam: shifts:read · Modül: Vardiya
| Alan | Tür |
|---|---|
shift_ | kimlik (uuid) |
org_ | kimlik (uuid), null olabilir |
month | ay (YYYY-MM) |
shift.assignment.changed
Yayımlanmış planda bir kişinin o günkü vardiyası yazıldı, değişti ya da kaldırıldı.
Kapsam: shifts:read · Modül: Vardiya
| Alan | Tür |
|---|---|
employee_ | kimlik (uuid) |
work_ | gün (YYYY-MM-DD) |
roster.published
Nöbet çizelgesi onaylandı ve yayımlandı.
Kapsam: health_scheduling:read · Modül: Nöbet planlama
| Alan | Tür |
|---|---|
roster_ | kimlik (uuid) |
org_ | kimlik (uuid), null olabilir |
start_ | gün (YYYY-MM-DD) |
end_ | gün (YYYY-MM-DD) |
roster.assignment.changed
Yayımlanmış çizelgede bir hücre değişti (düzenleme, takas ya da açık vardiya).
Kapsam: health_scheduling:read · Modül: Nöbet planlama
| Alan | Tür |
|---|---|
roster_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
work_ | gün (YYYY-MM-DD) |
physician.availability.changed
HBYS senkronu bir hekimin randevu aralığını kapattı ya da açtı (personel kodu ve kesin saatler çekme ucunda).
Kapsam: health_scheduling:read, leave:read · Modül: Nöbet planlama, İzin
| Alan | Tür |
|---|---|
employee_ | kimlik (uuid) |
start_ | gün (YYYY-MM-DD) |
end_ | gün (YYYY-MM-DD) |
status | durum: closed, open |
payroll.period.approved
Bordro dönemi onaylandı. Tutar gövdede yoktur.
Kapsam: events:read · Modül: Bordro
| Alan | Tür |
|---|---|
payroll_ | kimlik (uuid) |
period | ay (YYYY-MM) |
expense.claim.approved
Masraf talebi onaylandı. Tutar gövdede yoktur.
Kapsam: events:read · Modül: Masraf
| Alan | Tür |
|---|---|
expense_ | kimlik (uuid) |
employee_ | kimlik (uuid) |
expense_ | gün (YYYY-MM-DD) |
signature.envelope.completed
İmza zarfı tamamlandı. Belgenin adı ve imzacılar gövdede yoktur.
Kapsam: events:read · Modül: Doküman
| Alan | Tür |
|---|---|
envelope_ | kimlik (uuid) |
employee_ | kimlik (uuid), null olabilir |
level | durum: basic, qualified_or_wet |
outcome | durum: approved, evidence, signed |
recruiting.application.hired
Başvuru işe alındı olarak işaretlendi.
Kapsam: events:read · Modül: İşe alım
| Alan | Tür |
|---|---|
application_ | kimlik (uuid) |
opening_ | kimlik (uuid) |
candidate_ | kimlik (uuid) |
approval.task.created
Bir onay görevi sırası gelip görevlisine açıldı. Talebin konusu gövdede yoktur.
Kapsam: events:read · Modül: Onaylar
| Alan | Tür |
|---|---|
approval_ | kimlik (uuid) |
approval_ | kimlik (uuid) |
assignee_ | kimlik (uuid) |
stage | sıra numarası |
webhook.ping
Deneme olayı: yalnız adı geçen uca gider.
Kapsam: events:read
| Alan | Tür |
|---|---|
endpoint_ | kimlik (uuid) |