Webhook’lar ve REST API

Channels & Integrations6 görüntüleme

Webhook’lar ve REST API

Conviro, gerçek zamanlı olay bildirimleri için webhook’lar ve platformun tüm özelliklerine programatik erişim için bir REST API sunar.

Webhook’lar

Webhook Nedir?

Webhook’lar, Conviro’da belirli bir olay gerçekleştiğinde sunucunuza bir HTTP POST isteği gönderir. Böylece sürekli sorgulama (polling) yapmadan gerçek zamanlı tepki verebilirsiniz.

Kullanılabilir Olaylar

OlayNe Zaman Tetiklenir
message.newYeni bir mesaj gönderildiğinde (ziyaretçi veya bot tarafından)
session.startedYeni bir görüşme oturumu başladığında
session.closedBir görüşme kapatıldığında
session.handoffBir görüşme canlı temsilciye aktarıldığında
lead.capturedYeni bir potansiyel müşteri kaydedildiğinde
contact.createdYeni bir kişi oluşturulduğunda
ticket.createdBir destek talebi açıldığında
csat.submittedBir CSAT puanı gönderildiğinde

Kurulum

  1. Dashboard -> Settings -> Webhooks yolunu açın.
  2. Add Webhook’a tıklayın.
  3. Uç nokta URL’nizi girin (HTTPS olmalıdır).
  4. Almak istediğiniz olayları seçin.
  5. Save’e tıklayın.

Güvenlik: HMAC-SHA256 İmzalama

Her webhook yükü, webhook secret’ınız kullanılarak HMAC-SHA256 ile imzalanır. Gerçekliğinden emin olmak için imzayı kendi sunucunuzda doğrulayın:

X-Conviro-Signature: sha256=<hex_digest>

Bu başlığı, webhook secret’ınızla hesapladığınız ham istek gövdesinin HMAC-SHA256 özetiyle karşılaştırın.

Yeniden Deneme Politikası

Uç noktanız 2xx dışında bir durum kodu döndürürse Conviro, üstel geri çekilmeyle (1 dk, 5 dk, 30 dk) en fazla 3 kez yeniden dener.


REST API

Kimlik Doğrulama

  1. Dashboard -> Settings -> API Keys -> Create Key üzerinden bir API anahtarı oluşturun.
  2. Anahtarı Authorization başlığına ekleyin:
Authorization: Bearer sk_your_api_key_here

Başlıca Uç Noktalar

MetotUç NoktaAçıklama
GET/api/chatbotsTüm chatbot’ları listeler
GET/api/chatbots/:idChatbot ayrıntılarını getirir
GET/api/sessionsOturumları listeler (filtrelerle)
GET/api/sessions/:id/messagesBir oturumun mesajlarını getirir
POST/api/sessions/:id/messagesBir oturuma mesaj gönderir
GET/api/contactsKişileri listeler
POST/api/contactsKişi oluşturur
GET/api/leadsPotansiyel müşterileri listeler
POST/api/leadsPotansiyel müşteri oluşturur
GET/api/analytics/overviewAnaliz özetini getirir

İstek Limitleri

  • Free planı: dakikada 60 istek
  • Starter: dakikada 120 istek
  • Pro: dakikada 300 istek
  • Growth+: dakikada 600 istek

İstek limiti başlıkları her yanıta eklenir:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1672531200

Tam Dokümantasyon

İstek/yanıt örnekleriyle birlikte eksiksiz API referansı için /developers adresini ziyaret edin.

webhookapiresthmacintegrationendpointsdeveloper

Bu makale yardımcı oldu mu?