Digio webhooks can be used for receiving server to server events, by providing an HTTP based endpoint, where Digio keeps publishing the events. You can enable webhooks from your enterprise dashboard - profile section.
See the integration guide for steps on setting up the webhook on Digio Dashboard
Webhook Events for Digi Sign
| Event | Entity | Description |
|---|---|---|
| DOC.SIGNED | SIGN | Raised when document is signed successfully |
| DOC.SIGN.FAILED | SIGN | Raised when document signing is failed |
| DOC.SIGN.REJECTED | SIGN | Raised when document signing is rejected |
Webhook Entities with Payload
-
SIGN REQUEST COMPLETED{ "entities": [ "document" ], "payload": { "document": { "updated_at": 1612331669000, "sign_request_details": { "identifier": "rishabh@digio.in", "expire_on": 1613240999000, "name": "Rishabh Test Account", "requested_on": 1612331669000, "requester_type": "org" }, "file_name": "test.pdf", "agreement_status": "completed", "id": "DID210203112428801WRLZNUOYR345SJ", "signing_parties": [ { "has_dependents": null, "signature_mode": null, "identifier": "8087633559", "reason": "esign", "type": "self", "signature_type": "aadhaar", "signing_index": null, "updated_at": 1612331810000, "expire_on": 1613240999000, "name": "Abhinav Parashar", "skip_primary_sign": null, "pki_signature_details": { "name_validation_score": 100, "aadhaar_suffix": "8946", "gender": "M", "name": "Abhinav Parashar", "postal_code": "321203", "display_name": "Abhinav Parashar", "hash_of_photograph": "C80ADFDAD35B0DBD671B8B6C3DDC8D0E7D4EEB406DE71C5C4E425FBBF03955D8", "year_of_birth": "1987" }, "dependents": null, "next_dependent": null, "status": "signed" }, { "has_dependents": null, "signature_mode": null, "identifier": "8890091212", "reason": "esign", "type": "self", "signature_type": "aadhaar", "signing_index": null, "updated_at": 1612331669000, "expire_on": 1613240999000, "name": "Abhay puri", "skip_primary_sign": null, "pki_signature_details": { "name_validation_score": 54, "aadhaar_suffix": "8946", "gender": "M", "name": "Abhinav Parashar", "postal_code": "321203", "display_name": "Abhay puri", "hash_of_photograph": "C80ADFDAD35B0DBD671B8B6C3DDC8D0E7D4EEB406DE71C5C4E425FBBF03955D8", "year_of_birth": "1987" }, "dependents": null, "next_dependent": null, "status": "signed" } ], "others": { "last_signed_by": "8890091212", "has_all_signed": true } } }, "created_at": 1612332250000, "id": "WHN2102031134107462ZH2S89SR5WDVG", "event": "doc.signed" }
-
SIGN REQUEST REJECTED{ "entities": [ "document" ], "payload": { "document": { "error_message": null, "validation_results": { "overallResult": "FAIL", "ruleResults": [ { "rule_id": 1, "result": "FAIL", "conditions": [ { "fuzzy_score": null, "result": "PASS", "field": "GENDER", "match": "EXACT", "actual_value": "M", "expected_value": "M" }, { "fuzzy_score": null, "result": "FAIL", "field": "AADHAAR", "match": "EXACT", "actual_value": "7142", "expected_value": "7145" } ] }, { "rule_id": 2, "result": "PASS", "conditions": [ { "fuzzy_score": null, "result": "FAIL", "field": "YOB", "match": "EXACT", "actual_value": "1997", "expected_value": "1996" }, { "fuzzy_score": 83, "result": "PASS", "field": "NAME", "match": "FUZZY", "actual_value": "Someone Something", "expected_value": "Some Thing" } ] } ] }, "signer_identifier": "someone@something.in", "error_code": null, "id": "DID230519170552323OQPMNF8XBDVAYO", "others": null } }, "created_at": 1684496220000, "id": "WHN230519170700329DEIO1NSND4O17S", "event": "doc.sign.rejected" }
-
SIGN REQUEST FAILED{ "entities": [ "document" ], "payload": { "document": { "error_message": "UIDAI Server Down", "validation_results": null, "signer_identifier": "someone@something.in", "error_code": "ESP-###", "id": "DID230519170552323OQPMNF8XBDVAYO", "others": null } }, "created_at": 1684496220000, "id": "WHN230519170700329DEIO1NSND4O17S", "event": "doc.sign.failed" }
Reference
For more detailed steps on setting up the webhook and reference for the same
See Webhook Guide