İçeriğe geç
Rex, yapay zekâ asistanınız: angarya işler ondan, fikirler sizden 👉 Rex ile tanışın

Webhook'larla verileri kendi sistemlerinize gönderin

Biri kaydolduğunda, katıldığında ya da kazandığında kendi URL'nize bir istek gelsin: imzalı payload, basic auth, özel payload ve her gönderimin kaydıyla.

Webhook, bir şey olduğu anda, örneğin biri bir kampanyaya katıldığında veya bir ödül kazandığında, verileri seçtiğiniz bir URL'ye gönderir. Bu verileri alan sistemi geliştiriciniz kurar.

Webhook'lar, Webhooks & API içeren planlara (Basic ve üzeri) dahildir.

Kampanya webhook'ları mı, hesap webhook'ları mı?

  • Kampanya webhook'ları kampanya düzenleyicisinde kurulur ve yalnızca o kampanya için tetiklenir. "Every time a lead participates in a campaign" ve "When a lead wins a prize" olaylarına ve en fazla seçeneğe sahiptir.
  • Hesap webhook'ları Settings > Webhooks altında kurulur. "When a new lead is created" olayına sahiptir: hangi kampanyadan gelmiş olursa olsun, kişi lead'lerinize ilk kez eklendiğinde, kişi başına bir kez tetiklenir.

Bir kampanyaya webhook ekleyin

  1. Kampanyayı düzenleyicide açın ve Connect > Webhooks bölümüne gidin.
  2. Add webhook düğmesine tıklayın.
  3. Payload URL girin. https ile başlamalıdır: "We only support webhooks over HTTPS to ensure that the data sent remains secure."
  4. Content type seçin: application/json veya application/x-www-form-urlencoded.
  5. Method seçin. Form, verileri URL içinde gönderen GET ile başlar. Verileri gövdede göndermek için POST seçin; çoğu sistem bunu bekler.
  6. Authentication altında (yalnızca POST için), URL'niz kullanıcı adı ve parola gerektiriyorsa Basic Auth seçin ve Username ile Password alanlarını doldurun. Aksi halde None olarak bırakın.
  7. İstekleri imzalamak için bir Secret girin (önerilir). Aşağıdaki "İmzayı doğrulayın" bölümüne bakın.
  8. Sisteminizin ne yanıt verdiğini görmek istiyorsanız Log response body seçeneğini açın. "Enable to store the response body for debugging."
  9. Active seçeneğini açık tutun. "We will only deliver events if the webhook is active."
  10. Olayı seçin: "Every time a lead participates in a campaign" veya "When a lead wins a prize".
  11. Alanları kendiniz belirlemek istiyorsanız Custom payload seçeneğini açın (aşağıya bakın).
  12. Add webhook düğmesine tıklayın. "Webhook added" mesajını görürsünüz.

Webhooks paneli, kampanyanın webhook'larını Active veya Inactive durumuyla, son istek başarısız olduysa da Last delivery failed ibaresiyle listeler. Bir webhook'u Edit, See deliveries veya Delete ile yönetmek için Actions menüsünü kullanın. Bir webhook'u düzenlerken mevcut secret'ı korumak için Secret alanını boş bırakın.

Hesap webhook'u ekleyin

  1. Settings > Webhooks bölümüne gidin (Developers altında). Webhook'larınız My webhooks altında (birden fazla lead listeniz varsa her listenin adı altında) listelenir.
  2. Webhook eklemek için artı işaretli karta tıklayın. Add webhook iletişim kutusunda "Send a request to an external URL whenever selected events happen." yazar.
  3. Payload URL, Content type ("Select content type of the webhook"), Method ve Secret alanlarını yukarıdaki gibi doldurun.
  4. Which events should trigger the webhook? altında "When a new lead is created" seçeneğini seçin.
  5. Kendi alanlarınızı kullanmak istiyorsanız "Yes, allow me to specify a customized payload (Advanced users only)" kutusunu işaretleyin.
  6. Gerekirse Log response body ("This webhook will log the response body") kutusunu işaretleyin ve Active kutusunu işaretli tutun ("We will deliver event details when this hook is triggered").
  7. Add webhook düğmesine tıklayın.

Bir webhook'u değiştirmek (Save changes), New secret belirlemek, Show deliveries açmak veya Delete webhook ile silmek ("This action cannot be reverted!") için webhook'a tıklayın.

Neler gönderilir?

Varsayılan olarak gövdede bir event (olayın adı: lead_created_on_campaign, new_campaign_winner veya lead_created) ve bir data nesnesi bulunur:

  • campaign: kampanyanın id ve name değerleri (kampanya webhook'ları)
  • lead: lead'in form alanları, alan anahtarlarıyla (örneğin first_name), ayrıca id, phone_number ve created_at
  • lead.permissions: her onay kutusu için kabul edilip edilmediği, metni, tarihi ve IP adresi (kampanya webhook'ları)
  • participant: kişinin geldiği channel ve katılım zamanı (kampanya webhook'ları)
  • quiz: adlandırılmış quiz sorularının yanıtları, ayrıca "Simple" ile başlayan okunabilir adlar altında
  • prize: ödülün id, name, value, coupon_code değerleri ve kazanılma zamanı (kazanan webhook'ları)

Boş değerler ve kabul edilmeyen onaylar gönderilmez. GET yönteminde aynı veriler URL'de sorgu parametreleri olarak gönderilir.

Özel payload

Custom payload açıkken yalnızca seçtiğiniz alanlar gönderilir ve event sarmalayıcısı bulunmaz.

  1. Data mapping altında Add mapping düğmesine tıklayın.
  2. Sisteminizin beklediği Field name değerini yazın. Harf, rakam, tire ve alt çizgi kullanın.
  3. Gönderilecek Scratcher alanını ("Group → Field") seçin ya da Custom value seçip sabit bir Value yazın.
  4. Her alan için tekrarlayın. Bir eşlemeyi çöp kutusu simgesiyle (Remove veya Remove data mapping) kaldırın.

İmzayı doğrulayın

Bir secret belirlediyseniz her istekte bir X-Hub-Signature başlığı bulunur: sha1= ve ardından, secret'ınız anahtar olarak kullanılarak JSON olarak kodlanmış payload'ın (yukarıda açıklanan gövde) HMAC-SHA1 hash'i. İsteğin gerçekten Scratcher'dan geldiğinden emin olmak için aynı değeri kendi tarafınızda hesaplayıp karşılaştırın.

Gönderimler ve yeniden denemeler

  • URL'niz yanıt vermezse veya hata döndürürse (400 ya da daha yüksek durum kodu), Scratcher iki kez daha dener: 5 saniye sonra ve bir dakika sonra.
  • Yönlendirmeler izlenmez, bu nedenle nihai URL'yi kullanın.
  • Her isteği ve yanıtı görmek için gönderimleri açın (kampanyada See deliveries, hesap webhook'larında Show deliveries). Her gönderimde ID, Request ve durum koduyla birlikte Response (kaydediyorsanız Response body de) gösterilir. Bir payload'ı kopyalamak için copy kullanın.
  • Yalnızca sorunları görmek için Show only failed deliveries seçeneğini açın. Üstte "Failed deliveries in the last 60 days" gösterilir.
  • Bir gönderimi yeniden göndermek için Retry düğmesine tıklayın: "The webhook is being resent."
  • "Webhook delivery logs are retained for 60 days."

Sorun giderme

  • "The ... field must use HTTPS.": Payload URL http ile başlıyor. https kullanın.
  • Tüm gönderimler yanıt alınamadan başarısız oluyor: URL'ye internetten erişilemiyor, örneğin yerel veya dahili bir adres. Herkese açık bir URL kullanın.
  • Sisteminize veri gelmiyor: yöntem GET olduğu için veriler URL'de. POST yöntemine geçin.
  • Sisteminizin beklediği bir alan eksik: alan boştu ya da onay kabul edilmedi. Sisteminizin eksik alanları boş olarak değerlendirmesini sağlayın.
Yardıma mı ihtiyacınız var?

Hâlâ yardıma mı ihtiyacınız var?

Size yardımcı olmak için gerçek insanlar burada. Scratcher'ı zaten kullanıyorsanız en hızlı yol platformun içindeki sohbettir.

  • Bizimle sohbet edin

    Giriş yapın ve sağ alt köşedeki sohbet düğmesine tıklayın. Rex hemen yanıt verir, ekibimiz de bir tık uzağınızda.

  • Toplantı ayarlayın

    Ekibimizle ücretsiz 30 dakikalık görüntülü görüşme: bir tur, kampanya fikirleri veya kurulumunuz için destek.

  • Bize e-posta gönderin

    contact@scratcher.io adresine yazın, size geri dönelim.