Giden Webhook'lar

FreeMaint olaylarını dış sistemlerinize gerçek zamanlı olarak gönderin

5 dk okuma
Bu bölümü yazdır

Webhook'lar, bir şey olur olmaz FreeMaint'in sizin kontrolünüzdeki bir URL'ye POST göndermesini sağlar; böylece başka bir sistem (ERP, faturalama, stok, muhasebe, bir sohbet kanalı) kimse veriyi yeniden girmeden uyumlu kalır. /company-settings/webhooks üzerinden yapılandırılır. Starter günde 100 teslimatla sınırlıdır; Business ve üzeri sınırsızdır. Tam yük referansı için API & GraphQL > Webhook'lar bölümüne bakın.

Kullanılabilir olaylar

  • work_order.created — bir iş emri oluşturuldu
  • work_order.completed — bir iş emri Tamamlandı durumuna geçti
  • work_order.status_changed — bir iş emri herhangi bir duruma geçti; work_order.completed da tetiklenmeye devam eder
  • request.created — bir bakım talebi gönderildi
  • request.status_changed — bir talep onaylandı, reddedildi veya iptal edildi
  • part.low_stock — bir yedek parça yeniden sipariş noktasına veya altına düştü
  • part.out_of_stock — bir yedek parçanın stoğu sıfıra indi
  • part.low_stock_summary — günde bir kez, hiç hareket görmemiş olanlar dahil, yeniden sipariş noktasında veya altında olan yedek parçalar
  • part.out_of_stock_summary — günde bir kez, stoğu sıfırda duran yedek parçalar
  • part.consumed — bir iş emrinde tüketildi veya iş emrinden iade edildi
  • compliance.chain_divergence — denetim hash zinciri koptu (Enterprise)
  • asset.downtime_started — bir makine duruşu açıldı
  • asset.downtime_ended — bir makine duruşu kapatıldı
  • report.daily_summary — günün tamamlanan işleri, seçtiğiniz saatte günde bir kez
  • purchase_order.created — bir satın alma siparişi oluşturuldu
  • purchase_order.status_changed — bir satın alma siparişi başka bir duruma geçti (onaylandı, sipariş verildi, iptal edildi…)
  • purchase_order.received — bir satın alma siparişine ait bir teslimat teslim alındı, kısmi teslimatlar dahil

Teslimat semantiği

  • JSON gövdeli POST: { event, timestamp, data }
  • X-FreeMaint-Signature başlığı — t=<unix saniye>,v1=<hex>; v1, webhook gizli anahtarınızla "<t>.<ham gövde>" dizesinin HMAC-SHA256'sıdır. Her istekte, ham gövdeye karşı doğrulayın
  • Ayrıca X-FreeMaint-Event ve X-FreeMaint-Delivery-Id gönderilir
  • Ağ hataları ve 5xx en fazla 3 kez üstel geri çekilmeyle yeniden denenir (yaklaşık 2 sn, 4 sn, 8 sn); 4xx kalıcı rettir ve yeniden denenmez
  • Her deneme, durumu, yanıt kodu ve deneme sayısıyla webhook altında kaydedilir — ve sonuçlanmış her teslimat oradan yeniden gönderilebilir
  • İsteğe bağlı fotoğraflar: "Fotoğrafları ekle" açıkken "work_order" ve "request" olayları "photos" alanında en fazla 4 görsel bağlantısı taşır; bağlantılar sahip olan herkes için 7 gün geçerlidir — yalnızca kontrol ettiğiniz bir uç nokta için açın

Yapılandırma

  1. /company-settings/webhooks adresini açın — Şirket ayarları yetkisi veya "Entegrasyonları yönetme" yetkisi gerekir.
  2. «Webhook Ekle»ye tıklayın — Bir ad, https:// bir URL verin ve istediğiniz olayları işaretleyin.
  3. İmza gizli anahtarını kopyalayın — Oluşturmada YALNIZCA bir kez gösterilir. Sonra «Gizli anahtarı döndür» ile yenisini üretebilirsiniz; eskisi geçersiz olur.
  4. Teslimatları izleyin — Olayların ulaştığını doğrulamak ve başarısız olanları yeniden göndermek için webhook'un teslimat geçmişini açın.

Pakete göre sınırlar

  • Starter — şirket başına günde 100 teslimat (sayaç 00:00 UTC'de sıfırlanır)
  • Business — sınırsız
  • Enterprise — sınırsız
  • Sayaç DENEMELERİ sayar: aynı olaydaki üç webhook üç birim harcar

İpucu

X-FreeMaint-Signature başlığını daima sunucu tarafında, ham istek gövdesine karşı doğrulayın — aksi hâlde gerçek bir FreeMaint olayını sahtesinden ayırt edemezsiniz ve sahte bir part.consumed ERP'nizde stok hareketi yaratabilir.

Bu sayfa yardımcı oldu mu?