Webhook API Entegrasyonu
Webhook'lar, bir olay meydana geldiğinde veya gelirken belirtilen URL'e otomatik HTTP POST isteği göndermek için kullanılır. InsurUp platformunda 18 adet webhook aktivitesi tanımlanmış durumda olup iki çeşit event tipi bulunmaktadır:
- Async: Event'ler bir olay gerçekleştiğinde atılır ve belirtilen API'ın sonucunu yapılan işleme etki etmez. Harici sistemlere açıktır.
- Sync: Event'ler bir olay gerçekleşmeden önce atılır ve belirtilen API'ın sonucuna göre yapılan işleme etki edebilir. Dahili kullanım içindir. Ödeme validasyonu güzel bir örnektir.
Webhook Entity Yapısı
Her webhook bir URL, secret (opsiyonel) ve dinlenecek event listesi içerir.
Header'lar
Webhook isteklerinde aşağıdaki header'lar gönderilir:
| Header | Açıklama |
|---|---|
x-webhook-event | Tetiklenen event'in ismidir |
x-webhook-id | Acente panelindeki oluşturulan webhook'un tekil numarasıdır |
x-webhook-delivery | Tekil gönderim numarasıdır |
x-webhook-signature | Bu header eğer secret alanı doluysa gönderilir. Belirtilen secret ile payload SHA-256 ile şifrelenir |
Event Özeti
📋 Teklif Primi (Proposal Premium) Olayları
| Event | Tanımlayıcı | Tip | Açıklama |
|---|---|---|---|
| ProposalPremiumReceived | proposal_premium.received | Async | Teklif prim hesaplaması alındığında ve başarıyla işlendiğinde tetiklenir |
| ProposalPremiumPurchasing | proposal_premium.purchasing | Sync | Teklif prim satın alma süreci başlatıldığında tetiklenir (sadece dahili kullanım) |
| ProposalPremiumPurchased | proposal_premium.purchased | Async | Teklif prim satın alımı başarıyla tamamlandığında tetiklenir |
| ProposalPremiumPurchaseFailed | proposal_premium.purchase_failed | Async | Teklif prim satın alma girişimi başarısız olduğunda tetiklenir |
📄 Poliçe (Policy) Olayları
| Event | Tanımlayıcı | Tip | Açıklama |
|---|---|---|---|
| PolicyCreated | policy.created | Async | Yeni bir sigorta poliçesi oluşturulup düzenlendiğinde tetiklenir |
| PolicyUpdated | policy.updated | Async | Mevcut bir sigorta poliçesi güncellendiğinde veya değiştirildiğinde tetiklenir |
👤 Müşteri (Customer) Olayları
| Event | Tanımlayıcı | Tip | Açıklama |
|---|---|---|---|
| CustomerCreated | customer.created | Async | Yeni bir müşteri oluşturulduğunda tetiklenir |
| CustomerUpdated | customer.updated | Async | Mevcut bir müşteri güncellendiğinde tetiklenir |
| CustomerKvkkConsentGiven | customer.kvkk_consent_given | Async | Müşteri KVKK açık rıza onayı verdiğinde tetiklenir |
| CustomerKvkkConsentRevoked | customer.kvkk_consent_revoked | Async | Müşteri KVKK açık rıza onayını geri çektiğinde tetiklenir |
| CustomerEtkConsentGiven | customer.etk_consent_given | Async | Müşteri ETK (Ticari Elektronik İleti) onayı verdiğinde tetiklenir |
| CustomerEtkConsentRevoked | customer.etk_consent_revoked | Async | Müşteri ETK onayını geri çektiğinde tetiklenir |
🚗 Araç (Vehicle) Olayları
| Event | Tanımlayıcı | Tip | Açıklama |
|---|---|---|---|
| VehicleCreated | vehicle.created | Async | Bir müşteriye yeni araç kaydı oluşturulduğunda tetiklenir |
| VehicleUpdated | vehicle.updated | Async | Mevcut bir araç kaydı güncellendiğinde tetiklenir |