Κληρονομιά Webhooks στο Legalesign

Τι είναι τα κληρονομικά webhooks

Τα κληρονομικά webhooks είναι το παλιότερο σύστημα webhooks μας. Αν σκέφτεστε να χρησιμοποιήσετε webhooks για πρώτη φορά, χρησιμοποιήστε το νεότερο σύστημα - νέα webhooks

Θα συνεχίσουμε να υποστηρίζουμε τα κληρονομικά webhooks για το προσεχές μέλλον ώστε να εξασφαλίσουμε συμβατότητα με το παρελθόν. Αν αυτό αλλάξει, θα λάβετε αρκετή ειδοποίηση. Συνιστούμε να αναβαθμίσετε ούτως ή άλλως, τα realtime webhooks ενεργοποιούνται για περισσότερα συμβάντα, περιέχουν πιο χρήσιμες πληροφορίες, μπορούν να φιλτραριστούν πιο αποτελεσματικά και συμβαίνουν ταχύτερα.

Τύποι webhook

Υπάρχουν δύο τύποι κληρονομικών webhooks.

• Με το [συμβάν] (καταργημένο)
• Όλα τα συμβάντα κάθε 6 λεπτά (καταργημένο)

Πώς να προσθέσετε ή να αφαιρέσετε ένα webhook

Προσθήκη ή αφαίρεση μέσω της web εφαρμογής

Μεταβείτε στις ρυθμίσεις και θα δείτε τον πίνακα webhooks. Η φόρμα έχει απλούς ελέγχους για να προσθέσετε ή να αφαιρέσετε webhooks

κίνδυνος

Το κλειδί API σας βασίζεται στον λογαριασμό σας και όχι σε μια μεμονωμένη ομάδα ή οργάνωση. Αυτό προσδίδει μεγαλύτερη ευελιξία στο κλειδί API σας, αλλά τα webhooks σας θα λαμβάνουν πληροφορίες από όλους τους λογαριασμούς όπου είστε διαχειριστής, τόσο dev όσο και prod. Για να διαφοροποιήσετε τα webhooks ανά ομάδα, είτε χρησιμοποιήστε το φίλτρο, είτε (η παλαιότερη μέθοδος) δημιουργήστε νέο διαχειριστή χρήστη που να είναι μέλος μόνο στην/στις ομάδα(-ες) στόχο, αποκτήστε κλειδί API για αυτόν τον λογαριασμό, και χρησιμοποιήστε τον για το webhook σας.

Προσθήκη ή αφαίρεση μέσω API

Χρησιμοποιήστε απλά αιτήματα GET και POST μέσω του REST API για να εμφανίσετε, δημιουργήσετε ή διαγράψετε webhooks.

Για περισσότερες πληροφορίες δείτε την τεκμηρίωση: API webhooks

Η μορφή ενός webhook 'Με το ...'

Αυτά είναι webhooks που ενεργοποιούνται για ένα συγκεκριμένο συμβάν - υπογραφή, δημιουργία, απόρριψη ή αποτυχημένη επίσκεψη.

Αυτά παραδίδονται ως αιτήματα POST στην url σας.

Περιέχουν το όνομα του εγγράφου, τον κωδικό συμβάντος, το URI πόρου, τις ετικέτες και το uuid του εγγράφου. Εδώ είναι η εκτύπωση από το ngrok.

Η μορφή ενός γενικού ενημερωτικού / 6 λεπτού webhook

Η κλήση των 6 λεπτών φαίνεται έτσι:

Όπως βλέπετε, είναι επίσης αίτημα POST. Αλλά αυτή τη φορά όλες οι πληροφορίες αποθηκεύονται στο πεδίο 'data' του POST ως αντικείμενο JSON.

Εδώ είναι το αντικείμενο JSON αναλυτικά:

[
  {
    "value": "5",
    "timestamp": "2022-07-11T07:28:25+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "10",
    "timestamp": "2022-07-11T07:28:26+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:28:55+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "40",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "100",
    "timestamp": "2022-07-11T07:29:09+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  }
]

Τι συμβαίνει εδώ; Το γενικό ενημερωτικό webhook σας δίνει τώρα όλες τις λεπτομέρειες για το τι συνέβη στην υπογραφή ενός εγγράφου, και πότε. Περιλαμβάνει ενημερώσεις συμβάντων τόσο για τον υπογράφοντα όσο και για το έγγραφο.

προειδοποίηση

Θα έχετε παρατηρήσει ότι χρησιμοποιούμε τις λέξεις 'παραλήπτης' και 'υπογράφων'. Αυτές είναι εναλλάξιμες. Η χρήση του παραλήπτη αντανακλά τους πιο σύνθετους ρόλους που είναι πλέον διαθέσιμοι στο Legalesign και θα είναι το νέο όνομα για τον 'υπογράφοντα' καθώς εξελίσσουμε το σύστημα.

Η ιστορία αυτών των δεδομένων webhook είναι πως το αντικείμενο υπογράφοντα δημιουργήθηκε (υπογράφων 5), στάλθηκε (υπογράφων 10), ο υπογράφων ολοκλήρωσε το πεδίο του (υπογράφων 30), και υπέγραψε (υπογράφων 40), το έγγραφο σημείωσε ότι τα πεδία του ήταν ολοκληρωμένα (έγγραφο 20), μετά χαρακτηρίστηκε ως υπογεγραμμένο (έγγραφο 30), και μετά έτοιμο για λήψη (έγγραφο 100).

Το '100' είναι ειδικός κωδικός συμβάντος για να επιβεβαιώσει ότι το έγγραφο είναι έτοιμο για λήψη.

Κατάσταση εγγράφου

Κατάσταση	Επεξήγηση
10	Απεσταλμένο
20	Πεδία ολοκληρωμένα
30	Ολοκληρωμένο
40	Αφαιρέθηκε (πριν την υπογραφή)
50	Απορρίφθηκε

Κατάσταση υπογράφοντα

Κατάσταση	Επεξήγηση
4	Μη αποσταλμένο
5	Προγραμματισμένο για αποστολή
10	Απεσταλμένο
15	Άνοιγμα email
20	Επισκεφθήκατε
30	Πεδία ολοκληρωμένα
35	Πεδία ολοκληρωμένα εκτός των πεδίων υπογραφής
39	Μάρτυρας για υπογραφή
40	Ολοκληρωμένο
50	Κατεβασμένο
60	Απορρίφθηκε

Αποσφαλμάτωση webhooks στον πίνακα ελέγχου API

Όλα τα webhooks καταγράφονται και μπορείτε να εξετάσετε το περιεχόμενό τους και τον κωδικό κατάστασης HTTP στον πίνακα ελέγχου API σας. Για να μάθετε περισσότερα δείτε το μαθήμα πίνακα ελέγχου

Μεταβείτε απευθείας στον πίνακα ελέγχου API.

Επικοινωνήστε μαζί μας

Αυτό καλύπτει όσα πρέπει να γνωρίζετε για τα κληρονομικά webhooks.

Αν έχετε περισσότερες ερωτήσεις, παρακαλούμε επικοινωνήστε μαζί μας - support.legalesign.com.