İçeriğe geç

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:read isteyen 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_id boş gelir ve durum yalnız görünen hâldir: belge bekleyen talep pending, reddedilen talep cancelled gö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

employee.created: Gövde alanları
AlanTür
employee_idkimlik (uuid)
org_unit_idkimlik (uuid), null olabilir
statusdurum: active, pre_start, inactive, terminated
hire_dategü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

employee.updated: Gövde alanları
AlanTür
employee_idkimlik (uuid)
changed_fieldsalan 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

employee.started: Gövde alanları
AlanTür
employee_idkimlik (uuid)
start_dategün (YYYY-MM-DD)

employee.terminated

Çalışanın işten çıkışı kaydedildi. Çıkış nedeni gövdede yoktur.

Kapsam: employees:read · Modül: Personel

employee.terminated: Gövde alanları
AlanTür
employee_idkimlik (uuid)
last_work_daygün (YYYY-MM-DD)

org_unit.changed

Birim açıldı, güncellendi, taşındı ya da silindi.

Kapsam: org:read · Modül: Organizasyon

org_unit.changed: Gövde alanları
AlanTür
org_unit_idkimlik (uuid)
parent_idkimlik (uuid), null olabilir
changedurum: created, updated, moved, removed

leave.request.created

İzin talebi açıldı.

Kapsam: leave:read · Modül: İzin

leave.request.created: Gövde alanları
AlanTür
leave_request_idkimlik (uuid)
employee_idkimlik (uuid)
leave_type_idkimlik (uuid), null olabilir
start_dategün (YYYY-MM-DD)
end_dategün (YYYY-MM-DD)
statusdurum: awaiting_document, pending, approved, rejected, cancelled

leave.request.approved

İzin talebi onaylandı.

Kapsam: leave:read · Modül: İzin

leave.request.approved: Gövde alanları
AlanTür
leave_request_idkimlik (uuid)
employee_idkimlik (uuid)
leave_type_idkimlik (uuid), null olabilir
start_dategün (YYYY-MM-DD)
end_dategün (YYYY-MM-DD)
statusdurum: awaiting_document, pending, approved, rejected, cancelled

leave.request.rejected

İzin talebi reddedildi.

Kapsam: leave:read · Modül: İzin

leave.request.rejected: Gövde alanları
AlanTür
leave_request_idkimlik (uuid)
employee_idkimlik (uuid)
leave_type_idkimlik (uuid), null olabilir
start_dategün (YYYY-MM-DD)
end_dategün (YYYY-MM-DD)
statusdurum: 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

leave.request.cancelled: Gövde alanları
AlanTür
leave_request_idkimlik (uuid)
employee_idkimlik (uuid)
leave_type_idkimlik (uuid), null olabilir
start_dategün (YYYY-MM-DD)
end_dategün (YYYY-MM-DD)
statusdurum: 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

overtime.request.approved: Gövde alanları
AlanTür
overtime_request_idkimlik (uuid)
employee_idkimlik (uuid)
work_dategü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

shift.plan.published: Gövde alanları
AlanTür
shift_plan_idkimlik (uuid)
org_unit_idkimlik (uuid), null olabilir
monthay (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

shift.assignment.changed: Gövde alanları
AlanTür
employee_idkimlik (uuid)
work_dategün (YYYY-MM-DD)

roster.published

Nöbet çizelgesi onaylandı ve yayımlandı.

Kapsam: health_scheduling:read · Modül: Nöbet planlama

roster.published: Gövde alanları
AlanTür
roster_idkimlik (uuid)
org_unit_idkimlik (uuid), null olabilir
start_dategün (YYYY-MM-DD)
end_dategü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

roster.assignment.changed: Gövde alanları
AlanTür
roster_idkimlik (uuid)
employee_idkimlik (uuid)
work_dategü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

physician.availability.changed: Gövde alanları
AlanTür
employee_idkimlik (uuid)
start_dategün (YYYY-MM-DD)
end_dategün (YYYY-MM-DD)
statusdurum: closed, open

payroll.period.approved

Bordro dönemi onaylandı. Tutar gövdede yoktur.

Kapsam: events:read · Modül: Bordro

payroll.period.approved: Gövde alanları
AlanTür
payroll_period_idkimlik (uuid)
perioday (YYYY-MM)

expense.claim.approved

Masraf talebi onaylandı. Tutar gövdede yoktur.

Kapsam: events:read · Modül: Masraf

expense.claim.approved: Gövde alanları
AlanTür
expense_claim_idkimlik (uuid)
employee_idkimlik (uuid)
expense_dategü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

signature.envelope.completed: Gövde alanları
AlanTür
envelope_idkimlik (uuid)
employee_idkimlik (uuid), null olabilir
leveldurum: basic, qualified_or_wet
outcomedurum: approved, evidence, signed

recruiting.application.hired

Başvuru işe alındı olarak işaretlendi.

Kapsam: events:read · Modül: İşe alım

recruiting.application.hired: Gövde alanları
AlanTür
application_idkimlik (uuid)
opening_idkimlik (uuid)
candidate_idkimlik (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

approval.task.created: Gövde alanları
AlanTür
approval_task_idkimlik (uuid)
approval_request_idkimlik (uuid)
assignee_membership_idkimlik (uuid)
stagesıra numarası

webhook.ping

Deneme olayı: yalnız adı geçen uca gider.

Kapsam: events:read

webhook.ping: Gövde alanları
AlanTür
endpoint_idkimlik (uuid)