Sealsimple
Ξεκινήστε δωρεάν

Συμβάντα εγγράφων στο σύστημά σας με webhooks

Ένα webhook στέλνει υπογεγραμμένο JSON στο URL σας όταν ένα έγγραφο στέλνεται, ανοίγεται, υπογράφεται, ολοκληρώνεται, απορρίπτεται, λήγει ή ακυρώνεται. Απαιτεί Pro και ρόλο κατόχου ή διαχειριστή.

Αυτή η μετάφραση είναι παλαιότερη από το αγγλικό άρθρο, οπότε ορισμένες λεπτομέρειες μπορεί να έχουν αλλάξει. Διαβάστε την αγγλική έκδοση

Ένα webhook στέλνει ένα μήνυμα σε ένα δικό σας URL κάθε φορά που συμβαίνει κάτι σε ένα έγγραφο, ώστε το σύστημά σας να μπορεί να αντιδράσει. Τα webhooks είναι μέρος του Pro: λειτουργούν σε έναν χώρο εργασίας όσο ένας από τους κατόχους του έχει Pro, και μόνο οι κάτοχοι και οι διαχειριστές μπορούν να τα διαχειρίζονται. Κάθε χώρος εργασίας έχει τα δικά του.

Προσθήκη webhook

  1. Ανοίξτε τις Ρυθμίσεις & επωνυμία στο μενού λογαριασμού και μεταβείτε στις Ενοποιήσεις.
  2. Πατήστε Προσθήκη webhook.
  3. Εισαγάγετε το URL τελικού σημείου. Πρέπει να ξεκινά με https:// και να είναι δημόσιο: διευθύνσεις σε ιδιωτικά δίκτυα, διευθύνσεις του ίδιου του Sealsimple και URL με όνομα χρήστη και κωδικό πρόσβασης απορρίπτονται.
  4. Αν θέλετε, προσθέστε ένα Όνομα, επιλέξτε τα Συμβάντα (αρχικά είναι όλα επιλεγμένα) και πατήστε Προσθήκη webhook.
  5. Αντιγράψτε το Μυστικό κλειδί υπογραφής που εμφανίζεται και πατήστε Αποστολή δοκιμαστικού συμβάντος.

Ένας χώρος εργασίας μπορεί να έχει έως 10 webhooks.

Συμβάντα

  • document.sent: Το έγγραφο στάλθηκε
  • document.viewed: Το άνοιξε ένας παραλήπτης, μία φορά ανά παραλήπτη
  • document.signed: Το υπέγραψε ένας υπογράφων, μία φορά ανά υπογράφοντα
  • document.completed: Ολοκληρώθηκε: υπέγραψαν όλοι
  • document.declined: Απορρίφθηκε
  • document.expired: Έληξε
  • document.canceled: Ακυρώθηκε

Τι στέλνουμε

Ένα αίτημα POST με σώμα JSON: id (ίδιο σε κάθε προσπάθεια, ώστε να μπορείτε να παραλείπετε τα διπλότυπα), event, created_at, workspace_id, ένα document με id, title, status και url και, για συμβάντα που αφορούν ένα άτομο, ένα recipient με name, email και role. Ένα ακυρωμένο έγγραφο έχει την κατάσταση voided. Το ίδιο το υπογεγραμμένο PDF δεν αποστέλλεται. Το δοκιμαστικό συμβάν έχει το event test και ένα επινοημένο έγγραφο και υπογράφοντα.

Έλεγχος της υπογραφής

Κάθε αίτημα έχει μια κεφαλίδα Sealsimple-Signature όπως t=1700000000,v1=…, δίπλα στις Sealsimple-Event και Sealsimple-Delivery. Για να την ελέγξετε:

  1. Πάρτε το ακατέργαστο σώμα του αιτήματος, ακριβώς όπως έφτασε.
  2. Διαβάστε το t (χρόνος Unix σε δευτερόλεπτα) και το v1 από την κεφαλίδα.
  3. Υπολογίστε το HMAC-SHA256 του t, μιας τελείας και του σώματος, με ολόκληρο το μυστικό κλειδί υπογραφής σας ως κλειδί, σε πεζά δεκαεξαδικά.
  4. Αποδεχτείτε το αίτημα μόνο αν το αποτέλεσμα είναι ίσο με το v1 (σύγκριση σε σταθερό χρόνο) και το t δεν είναι παλαιότερο από λίγα λεπτά.

Στο Πώς να συνδεθείτε, ο Έλεγχος της υπογραφής (Node.js) δείχνει αυτή τη διαδικασία σε κώδικα, με Αντιγραφή κώδικα. Το Νέο κλειδί αντικαθιστά αμέσως το μυστικό κλειδί, οπότε ενημερώστε τον έλεγχό σας αμέσως μετά.

Επαναλήψεις, ιστορικό και παύση

Απαντήστε με κατάσταση 2xx εντός 10 δευτερολέπτων. Διαφορετικά προσπαθούμε ξανά αργότερα, έως 6 προσπάθειες συνολικά μέσα σε περίπου μία ημέρα. Οι ανακατευθύνσεις δεν ακολουθούνται και μια απάντηση 410 σταματά τις προσπάθειες. Το Ιστορικό παραδόσεων δείχνει τα τελευταία 50 μηνύματα με την απάντηση του τελικού σας σημείου, και η Επαναποστολή στέλνει ξανά ένα από αυτά.

Μετά από 20 διαδοχικές αποτυχημένες παραδόσεις, θέτουμε το webhook σε παύση (Σε παύση λόγω αποτυχιών) και στέλνουμε email στους κατόχους του χώρου εργασίας. Διορθώστε το τελικό σημείο, ενεργοποιήστε ξανά το webhook και στείλτε ξανά από το ιστορικό όσα χρειάζεστε. Μπορείτε επίσης να θέσετε ένα webhook σε παύση με τον διακόπτη του: τα συμβάντα που συμβαίνουν όσο είναι σε παύση δεν στέλνονται αργότερα. Χωρίς Pro, τα webhooks παραμένουν αλλά δεν στέλνουν τίποτα.

Σας βοήθησε αυτό το άρθρο;

Δοκιμάστε το με την επόμενη σύμβασή σας.

5 δωρεάν αποστολές κάθε ημερολογιακό μήνα. Χωρίς πιστωτική κάρτα.

Χρειάζεστε ακόμη βοήθεια;

Ρωτήστε τον βοηθό μας στη συνομιλία: απαντά αμέσως. Ή στείλτε μας email και ένας άνθρωπος θα σας απαντήσει εντός μίας εργάσιμης ημέρας.