Dokümanlar/Yönetici Kılavuzu/Webhook'lar

Webhook'lar

Kurumunuzda ilginç bir şey olduğunda HMAC ile imzalanmış olay teslimatları alan giden webhook uç noktaları kaydedin. Yönetici sayfası uç nokta CRUD'unu yönetir; ayrıntılı teslimat sözleşmesi — olay kataloğu, imza doğrulaması, yeniden deneme zamanlaması — API → Webhook'lar bölümünde yer alır.

Nerede yer alıyor

Kenar çubuğu → Entegrasyonlar bölümü altındaki Webhook'lar, /organization/webhooks adresinde.

Uç nokta oluşturma

+ Uç nokta ekle bağlantısına tıklayın. Diyalog şunları ister:

  • URL — teslimatları alacak genel HTTPS URL'si. Tüneller (cloudflared, ngrok) yerel geliştirme için iyi çalışır.
  • Açıklama (isteğe bağlı) — kısa not, örn. "Slack #appsec bildirici" veya "Jira bilet oluşturucu".
  • Olaylar — abone olunacak olay türleri. Bugün yayında olan dört olay assignment.created, assignment.completed, sarif.ingested ve certificate.issued.

Gönderildiğinde diyalog imzalama sırrını (whsec_…) yalnızca bir kez görüntüler. Hemen sırlar yöneticinize kopyalayın. Gelen her teslimatı doğrulamak için ona ihtiyacınız var; Node, Python ve Go'da doğrulama kodu için API → Webhook'lar bölümüne bakın.

Uç noktaları listeleme

Liste görünümü kurumunuz için her webhook uç noktasını gösterir. Her satır URL'yi, abone olunan olayları, oluşturucuyu ve canlı bir sağlık göstergesini taşır:

DurumAnlamı
SağlıklıSon teslimat 2xx yanıtı döndürdü.
BaşarısızSon teslimat 2xx olmayan bir yanıt döndürdü veya zaman aşımına uğradı ama uç nokta hâlâ yeniden deneniyor.
BeklemedeUç nokta var ama henüz ilk teslimatını almadı.
Devre DışıUç nokta yakın bir teslimatta yeniden deneme zamanlamasını tüketti ve otomatik olarak devre dışı bırakıldı. Son teslimat zaman damgası, ne zaman başarısız olduğunu görebilmeniz için korunur.

Düzenleme ve silme

URL'yi, açıklamayı veya olay abonelik listesini güncellemek için Düzenle bağlantısına tıklayın. Aktif anahtarını kapatmak uç noktayı silmeden teslimatı duraklatır; tekrar açmak teslimatı sürdürür ve otomatik devre dışı durumu temizler. Uç noktayı tamamen kaldırmak için Sil bağlantısına tıklayın — bekleyen teslimatlar iptal edilir ve satır listeden düşer.

Son teslimatları inceleme

Her satırdaki ⟳ Teslimatlar düğmesi o uç nokta için en son 50 teslimat denemesini listeleyen bir çekmece açar. Her giriş olay türünü, olay kimliğini, mevcut durumu (pending / delivered / failed / exhausted), deneme sayısını, uç noktanız tarafından döndürülen HTTP durum kodunu, varsa hata mesajını ve zaman damgalarını gösterir.

Kendi alıcınızı incelemek zorunda kalmadan hatalı davranan bir tüketiciyi hata ayıklamak için bu görünümü kullanın — alıcı bir 5xx döndürüyorsa, burada gördüğünüz mesaj uygulamanızın günlüğe kaydettiği aynı mesajdır.

Yeniden deneme ve otomatik devre dışı bırakma

Başarısız teslimatlar 1dk → 5dk → 30dk → 2sa zamanlamasıyla toplam beş denemeye kadar yeniden denenir. Beşinci başarısızlıktan sonra uç nokta otomatik olarak devre dışı bırakılır ve son teslimat exhausted olarak işaretlenir. Yeniden etkinleştirmek için alıcıyı düzeltin, ardından Düzenle diyaloğunda Aktif bağlantısına tıklayın veya {"isActive": true} ile API PATCH /api/sch/org/webhooks/{id} gönderin.

Programatik erişim

Bu sayfadaki her eyleme genel API üzerinden de ulaşılabilir — CRUD yüzeyi ve teslimat sözleşmesi için API → Webhook'lar bölümüne bakın.