Formstep

Kendi uç noktanıza imzalı JSON

Hedef kendi arka ucunuz, sunucusuz bir fonksiyon ya da yerel entegrasyonu olmayan bir araçsa entegrasyon webhook'tur. Her gönderim alan anahtarlarıyla tek bir JSON olayı olarak gelir, Formstep'ten geldiğini kanıtlayabilmeniz için imzalıdır ve uç noktanız evet diyene kadar yeniden denenir.

Güncellendi

Nasıl çalışır

  1. Formun Entegrasyonlar bölümünü açın, Webhook’u seçin ve URL’yi yazın. Tüm alanları göndermek için eşlemeyi boş bırakın; yalnızca bazılarını, seçtiğiniz JSON anahtarlarıyla göndermek için satır ekleyin. Örnek isteği görün, siz düzenledikçe gövdenin değişimini gösterir.
  2. whsec_ ile başlayan ve yalnızca bir kez gösterilen imzalama sırrını kopyalayın. Yetkilendirme token’ı gibi en fazla beş özel başlık ekleyin.
  3. Webhook entegrasyonunu etkinleştir’e, ardından Test olayı gönder’e tıklayın: örnek yanıtlar ve başlıklarınızla imzalı bir POST; gerçek bir teslimat gibi olay günlüğüne kaydedilir.

Tam rehberi görün

Ne gelir

Formstep’in gönderdiği her şey için tek bir zarf: id, type, createdAt, apiVersion, test ve data. data altında: form; kimliği, yanıtlayanın e-postası, zamanı, dili ve PDF bağlantısıyla gönderim; kod için alan anahtarlarıyla anahtarlanmış bir answers nesnesi ve aynı anahtarlarla okunabilir metin içeren bir display nesnesi. Bir seçim yanıtı answers içinde seçenek anahtarı, display içinde etiketidir; bir dosya, birinde indirme URL’lerinin, ötekinde dosya adlarının listesidir. Bir isteği yanıtlayan gönderim, harici kimliğinizi ve meta verilerinizi içeren bir request bloğu ekler.

X-Formstep-Signature: t=TIMESTAMP,sha256=HEX

Bir formun birden çok webhook’u olabilir; her biri her gönderim ve sonraki her düzenleme için tetiklenir; bu ikisi type ile ayırt edilir. Alıcınız fields.list çağrısını kendisi yapamıyorsa Alan listesini her olayla gönder seçeneğini açın.

Yeniden denemeler

Her 2xx başarıdır. Formstep en fazla beş kez dener: hemen, sonra en az 1, 2, 4 ve 8 dakika sonra; son deneme ilkinden yaklaşık iki saat sonra olur. 429, 5xx, zaman aşımları ve bağlantı hataları yeniden denenir; daha uzun bir Retry-After dikkate alınır. 401, 403 ve 404 entegrasyonu hemen durdurur ve kurulumu yapan kişiye e-posta gönderir. Beş denemenin hepsini kullanan teslimatlar entegrasyonda bir bantta görünür; Tümünü Yeniden Dene onları yeniden gönderir ve duraklatılmış bir entegrasyonu tekrar açar.

Yerel geliştirmede geliştirme sunucunuzu ngrok ya da bir Cloudflare tüneliyle dışarı açın ve webhook’u ona yönlendirin. Bitirilmemiş genel bağlantı yanıtları için REST API ile bir submission_abandoned aboneliği oluşturun; burada eklediğiniz webhook bunlar için hiç tetiklenmez.

Make veya Pipedream gibi webhook tetikleyicili bir iş akışı aracı da bunları alabilir. Alıcı belirli bir kişiyi bekleyen bir iş akışıysa webhook yerine isteğin geri çağırması işinize yarar: o istek için, sonucuyla birlikte bir kez tetiklenir.

Webhooks için Formstep hakkında sorular

Aklınızda başka bir şey mi var? Dokümanlar her ayarı anlatıyor, e-postalara da yanıt veriyoruz.

Webhook forma aittir ve paylaşım bağlantılarından da isteklerden de gelen her gönderim için tetiklenir. Geri çağırma tek bir isteğe aittir: istek oluştururken callbackUrl olarak verdiğiniz URL, o istek bittiğinde bir kez çağrılır. İkisi de aynı olay zarfını taşır.

Her istekte t=TIMESTAMP,sha256=HEX biçiminde bir X-Formstep-Signature başlığı bulunur: TIMESTAMP, bir nokta ve ham gövdenin imzalama sırrınızla HMAC-SHA256 değeri. Bu değeri, gövdenin tam olarak geldiği hali üzerinden hesaplayın. Webhook başvuru belgesinde kopyalayabileceğiniz bir kod parçası var.

Çalışma alanının sahibi bunu panoda görebilir; diğer üyeler webhook'un geri kalanını görür. Yeniden üretilemez: yeni bir sır için webhook'u silip yenisini oluşturun.

Herkese açık bir adreste HTTPS, en fazla 2.048 karakter, URL'de kimlik bilgisi olmadan. Geliştirme sırasında localhost için düz http:// çalışır. Formstep ana makine adını her teslimattan önce yeniden denetler; bu yüzden sonradan iç bir adrese yönlendirilen bir DNS kaydı yine reddedilir.

Kimden olursa olsun, bilgi toplayın.

Örnek bir form yayınlayın, alıcınız gibi yanıtlayın ve yanıtların geri gelişini izleyin. Hesap gerekmez.

Dokümanları okuyun