29 implement docusign webhook listener (#49)

* added event data for all events except envelope discard, recipient auto responded, recipient authentication failure, and recipient delegate * setup webhook api route * separated source code into a src folder and created a docusign webhook simulate tool * removed key and added TODO for docusign auth
castlepointanime · Nov 1, 2023 · c117c51 · c117c51
1 parent 8a818ca
commit c117c51
Show file tree

Hide file tree

Showing 102 changed files with 1,899 additions and 468 deletions.
diff --git a/.flake8 b/.flake8
@@ -1,3 +1,3 @@
 [flake8]
 ignore = E501, E123
-exclude = __init__.py
+exclude = __init__.py, venv
diff --git a/Makefile b/Makefile
@@ -2,11 +2,11 @@ setup:
 	pip install -r requirements.txt
 
 check:  # TODO separate into production build setup
-	python3 -m mypy .
-	python3 -m flake8 .
+	cd ./src && python3 -m mypy .
+	cd ./src && python3 -m flake8 .
 
 run: setup
-	uvicorn app:app --reload --workers 2 --host 0.0.0.0 --port 3001
+	cd ./src && uvicorn app:app --reload --workers 2 --host 0.0.0.0 --port 3001
 
 clean:
-	find . -type f -name ‘*.pyc’ -delete
+	find . -type f -name ‘*.pyc’ -delete
diff --git a/docs/docusign-events/creation-workflow/20231031232049-envelope-created.json b/docs/docusign-events/creation-workflow/20231031232049-envelope-created.json
diff --git a/docs/docusign-events/creation-workflow/20231031232106-recipient-sent.json b/docs/docusign-events/creation-workflow/20231031232106-recipient-sent.json
diff --git a/docs/docusign-events/creation-workflow/20231031232108-envelope-sent.json b/docs/docusign-events/creation-workflow/20231031232108-envelope-sent.json
diff --git a/docs/docusign-events/creation-workflow/20231031232209-recipient-delivered.json b/docs/docusign-events/creation-workflow/20231031232209-recipient-delivered.json
diff --git a/docs/docusign-events/creation-workflow/20231031232305-recipient-completed.json b/docs/docusign-events/creation-workflow/20231031232305-recipient-completed.json
diff --git a/docs/docusign-events/creation-workflow/20231031232307-recipient-sent.json b/docs/docusign-events/creation-workflow/20231031232307-recipient-sent.json
diff --git a/docs/docusign-events/creation-workflow/20231031232411-recipient-delivered.json b/docs/docusign-events/creation-workflow/20231031232411-recipient-delivered.json
diff --git a/docs/docusign-events/creation-workflow/20231031232414-envelope-delivered.json b/docs/docusign-events/creation-workflow/20231031232414-envelope-delivered.json
diff --git a/docs/docusign-events/creation-workflow/20231031232433-recipient-completed.json b/docs/docusign-events/creation-workflow/20231031232433-recipient-completed.json
diff --git a/docs/docusign-events/creation-workflow/20231031232435-envelope-completed.json b/docs/docusign-events/creation-workflow/20231031232435-envelope-completed.json
diff --git a/docs/docusign-events/creation-workflow/README.md b/docs/docusign-events/creation-workflow/README.md
@@ -0,0 +1,21 @@
+# Creation workflow
+
+1. 20231031232049-envelope-created.json: Contract is first generated.
+2. 20231031232106-recipient-sent.json: An email is sent to the signer.
+3. 20231031232108-envelope-sent.json: The envelope has been sent to the signer.
+
+* Signer fills out the form, but doesn't click "Finish" yet
+
+4. 20231031232209-recipient-delivered.json: Signer finished fields
+
+* Signer clicks "Finish"
+
+5. 20231031232305-recipient-completed.json: Signer finished all fields
+
+* These are for the approver
+
+6. 20231031232307-recipient-sent.json: An email is sent to the approver.
+7. 20231031232411-recipient-delivered.json: Approver has finished fields (aka approver has finished signing)
+8. 20231031232414-envelope-delivered.json: Envelope is being made
+9. 20231031232433-recipient-completed.json: Approver has finished all fields
+10. 20231031232435-envelope-completed.json: Contract has been made
diff --git a/docs/docusign-events/random-events/20231031173349-envelope-created.json b/docs/docusign-events/random-events/20231031173349-envelope-created.json
diff --git a/docs/docusign-events/random-events/20231031173403-recipient-sent.json b/docs/docusign-events/random-events/20231031173403-recipient-sent.json
diff --git a/docs/docusign-events/random-events/20231031173406-envelope-sent.json b/docs/docusign-events/random-events/20231031173406-envelope-sent.json
diff --git a/docs/docusign-events/random-events/20231031173414-envelope-voided.json b/docs/docusign-events/random-events/20231031173414-envelope-voided.json
diff --git a/docs/docusign-events/random-events/20231031173418-envelope-deleted.json b/docs/docusign-events/random-events/20231031173418-envelope-deleted.json
diff --git a/docs/docusign-events/random-events/20231031173419-envelope-voided.json b/docs/docusign-events/random-events/20231031173419-envelope-voided.json
diff --git a/docs/docusign-events/random-events/20231031173422-envelope-deleted.json b/docs/docusign-events/random-events/20231031173422-envelope-deleted.json
diff --git a/docs/docusign-events/random-events/20231031173444-envelope-voided.json b/docs/docusign-events/random-events/20231031173444-envelope-voided.json
diff --git a/docs/docusign-events/random-events/20231031173554-recipient-sent.json b/docs/docusign-events/random-events/20231031173554-recipient-sent.json
diff --git a/docs/docusign-events/random-events/20231031173558-envelope-sent.json b/docs/docusign-events/random-events/20231031173558-envelope-sent.json
diff --git a/docs/docusign-events/random-events/20231031173618-recipient-delivered.json b/docs/docusign-events/random-events/20231031173618-recipient-delivered.json
diff --git a/docs/docusign-events/random-events/20231031173805-recipient-completed.json b/docs/docusign-events/random-events/20231031173805-recipient-completed.json
diff --git a/docs/docusign-events/random-events/20231031173808-recipient-sent.json b/docs/docusign-events/random-events/20231031173808-recipient-sent.json
diff --git a/docs/docusign-events/random-events/20231031173936-envelope-sent.json b/docs/docusign-events/random-events/20231031173936-envelope-sent.json
diff --git a/docs/docusign-events/random-events/20231031173940-recipient-resent.json b/docs/docusign-events/random-events/20231031173940-recipient-resent.json
diff --git a/docs/docusign-events/random-events/20231031173944-envelope-corrected.json b/docs/docusign-events/random-events/20231031173944-envelope-corrected.json
diff --git a/docs/docusign-events/random-events/20231031174002-recipient-delivered.json b/docs/docusign-events/random-events/20231031174002-recipient-delivered.json
diff --git a/docs/docusign-events/random-events/20231031174005-envelope-delivered.json b/docs/docusign-events/random-events/20231031174005-envelope-delivered.json
diff --git a/docs/docusign-events/random-events/20231031174013-recipient-completed.json b/docs/docusign-events/random-events/20231031174013-recipient-completed.json
diff --git a/docs/docusign-events/random-events/20231031174015-envelope-completed.json b/docs/docusign-events/random-events/20231031174015-envelope-completed.json
diff --git a/docs/docusign-events/random-events/20231031174824-envelope-created.json b/docs/docusign-events/random-events/20231031174824-envelope-created.json
@@ -0,0 +1 @@
+{"event": "envelope-created", "apiVersion": "v2.1", "uri": "/restapi/v2.1/accounts/6f7fcdd0-bc7f-484b-8a15-ed3af04c16ff/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "retryCount": 0, "configurationId": 10352224, "generatedDateTime": "2023-10-31T21:48:03.3822098Z", "data": {"accountId": "6f7fcdd0-bc7f-484b-8a15-ed3af04c16ff", "userId": "a6adfbcf-b92b-4754-80e4-21702de884f9", "envelopeId": "e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "envelopeSummary": {"status": "created", "documentsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/documents", "recipientsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/recipients", "attachmentsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/attachments", "envelopeUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "emailSubject": "", "envelopeId": "e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "signingLocation": "online", "customFieldsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/custom_fields", "notificationUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/notification", "enableWetSign": "true", "allowMarkup": "false", "allowReassign": "true", "createdDateTime": "2023-10-31T21:48:03.29Z", "lastModifiedDateTime": "2023-10-31T21:48:03.303Z", "statusChangedDateTime": "2023-10-31T21:48:03.29Z", "documentsCombinedUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/documents/combined", "certificateUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/documents/certificate", "templatesUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/templates", "expireEnabled": "true", "expireAfter": "120", "sender": {"userName": "Kevin Ha", "userId": "a6adfbcf-b92b-4754-80e4-21702de884f9", "accountId": "6f7fcdd0-bc7f-484b-8a15-ed3af04c16ff", "email": "[email protected]", "ipAddress": "69.114.96.68"}, "purgeState": "unpurged", "envelopeIdStamping": "true", "is21CFRPart11": "false", "signerCanSignOnMobile": "true", "autoNavigation": "true", "isSignatureProviderEnvelope": "false", "hasFormDataChanged": "false", "allowComments": "true", "hasComments": "false", "allowViewHistory": "true", "envelopeMetadata": {"allowAdvancedCorrect": "true", "enableSignWithNotary": "true", "allowCorrect": "true"}, "anySigner": null, "envelopeLocation": "current_site", "isDynamicEnvelope": "false", "burnDefaultTabData": "false"}}}
diff --git a/docs/docusign-events/random-events/20231031174846-envelope-created.json b/docs/docusign-events/random-events/20231031174846-envelope-created.json
diff --git a/docs/docusign-events/random-events/20231031174920-recipient-sent.json b/docs/docusign-events/random-events/20231031174920-recipient-sent.json
diff --git a/docs/docusign-events/random-events/20231031174922-envelope-sent.json b/docs/docusign-events/random-events/20231031174922-envelope-sent.json
diff --git a/docs/docusign-events/random-events/20231031174938-recipient-delivered.json b/docs/docusign-events/random-events/20231031174938-recipient-delivered.json
diff --git a/docs/docusign-events/random-events/20231031174941-recipient-finish-later.json b/docs/docusign-events/random-events/20231031174941-recipient-finish-later.json
diff --git a/docs/docusign-events/random-events/20231031175028-recipient-sent.json b/docs/docusign-events/random-events/20231031175028-recipient-sent.json
diff --git a/docs/docusign-events/random-events/20231031175032-recipient-reassign.json b/docs/docusign-events/random-events/20231031175032-recipient-reassign.json
diff --git a/docs/docusign-events/random-events/20231031175059-recipient-declined.json b/docs/docusign-events/random-events/20231031175059-recipient-declined.json
diff --git a/docs/docusign-events/random-events/20231031175103-envelope-declined.json b/docs/docusign-events/random-events/20231031175103-envelope-declined.json
diff --git a/docs/docusign-events/random-events/20231031230254-envelope-created.json b/docs/docusign-events/random-events/20231031230254-envelope-created.json
diff --git a/docs/docusign-events/random-events/20231031230313-recipient-sent.json b/docs/docusign-events/random-events/20231031230313-recipient-sent.json
diff --git a/docs/docusign-events/random-events/20231031230315-envelope-sent.json b/docs/docusign-events/random-events/20231031230315-envelope-sent.json
diff --git a/docs/docusign-events/random-events/20231031230340-recipient-resent.json b/docs/docusign-events/random-events/20231031230340-recipient-resent.json
diff --git a/docs/docusign-events/random-events/20231031230342-envelope-resent.json b/docs/docusign-events/random-events/20231031230342-envelope-resent.json
diff --git a/docs/docusign-events/random-events/20231031230421-envelope-deleted.json b/docs/docusign-events/random-events/20231031230421-envelope-deleted.json
diff --git a/docs/docusign-events/random-events/20231031230535-envelope-purge.json b/docs/docusign-events/random-events/20231031230535-envelope-purge.json
diff --git a/lambdaFunctions/docusignLambda/.gitignore b/lambdaFunctions/docusignLambda/.gitignore
diff --git a/lambdaFunctions/docusignLambda/Docusign.py b/lambdaFunctions/docusignLambda/Docusign.py
diff --git a/lambdaFunctions/docusignLambda/GoogleDrive.py b/lambdaFunctions/docusignLambda/GoogleDrive.py
diff --git a/lambdaFunctions/docusignLambda/README.md b/lambdaFunctions/docusignLambda/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{"event": "envelope-created", "apiVersion": "v2.1", "uri": "/restapi/v2.1/accounts/6f7fcdd0-bc7f-484b-8a15-ed3af04c16ff/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "retryCount": 0, "configurationId": 10352224, "generatedDateTime": "2023-10-31T21:48:03.3822098Z", "data": {"accountId": "6f7fcdd0-bc7f-484b-8a15-ed3af04c16ff", "userId": "a6adfbcf-b92b-4754-80e4-21702de884f9", "envelopeId": "e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "envelopeSummary": {"status": "created", "documentsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/documents", "recipientsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/recipients", "attachmentsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/attachments", "envelopeUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "emailSubject": "", "envelopeId": "e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0", "signingLocation": "online", "customFieldsUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/custom_fields", "notificationUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/notification", "enableWetSign": "true", "allowMarkup": "false", "allowReassign": "true", "createdDateTime": "2023-10-31T21:48:03.29Z", "lastModifiedDateTime": "2023-10-31T21:48:03.303Z", "statusChangedDateTime": "2023-10-31T21:48:03.29Z", "documentsCombinedUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/documents/combined", "certificateUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/documents/certificate", "templatesUri": "/envelopes/e03b5c92-5fd7-4f9d-bbf2-e16fcf8c36b0/templates", "expireEnabled": "true", "expireAfter": "120", "sender": {"userName": "Kevin Ha", "userId": "a6adfbcf-b92b-4754-80e4-21702de884f9", "accountId": "6f7fcdd0-bc7f-484b-8a15-ed3af04c16ff", "email": "[email protected]", "ipAddress": "69.114.96.68"}, "purgeState": "unpurged", "envelopeIdStamping": "true", "is21CFRPart11": "false", "signerCanSignOnMobile": "true", "autoNavigation": "true", "isSignatureProviderEnvelope": "false", "hasFormDataChanged": "false", "allowComments": "true", "hasComments": "false", "allowViewHistory": "true", "envelopeMetadata": {"allowAdvancedCorrect": "true", "enableSignWithNotary": "true", "allowCorrect": "true"}, "anySigner": null, "envelopeLocation": "current_site", "isDynamicEnvelope": "false", "burnDefaultTabData": "false"}}}