Links

• Partner option Template Method in Python
• Lucid chart: Activity Diagram and Class

Test trigger events for Two Signers

1. Creation of document triggers document_state_changed event → with the "status": "document.draft".
2. We need to send the document after that we trigger document_state_changed event → "status": "document.sent"
3. We need to send the document after that we trigger document_state_changed event → "status": "document.sent"
4. When the applicant opens the document the webhook received document_state_changed event → with the "status":"document.viewed"
5. After signing the 1st signer, we received recipient_completed event → "status": "document.viewed" → this event has action_by that we should check.
6. When the document is open for the second signer is trigger document_state_changed event → "status":"document.viewed"
7. When the document was signed for the 2nd signer document_state_changed event is received → with the "status": "document.completed"
8. And "event": "recipient_completed" → "status": "document.completed" → action_by

Note: Maybe events 6 and 7 can be switched to the order.

Test trigger events for Document were updated

1. Creation of document triggers document_state_changed event → with the "status": "document.draft"

2. We need to send the document after that we trigger document_state_changed event → "status": "document.sent"

3. When the applicant opens the document the webhook received document_state_changed event → with the "status":"document.viewed"

4. If the document is updated and it is not finished yet:

   1. we received "event": "document_updated" → "status": "document.draft"
   2. we received a second event "event": "document_state_changed" → "status": "document.draft"
   3. we need to send the document again, which triggers point 2 again

   • The document is not available for the signers

     

   Note: After of send again the document.

   1. We need to send the document after that we trigger document_state_changed event → "status": "document.sent"
   2. After signing the 1st signer, we received recipient_completed event → "status": "document.viewed" → this event has action_by that we should check.
   3. When the document was signed for the 2nd signer document_state_changed event is received → with the "status": "document.completed"

Test trigger events for Document Deleted

1. If the document is deleted (send to trash) "event": "document_deleted" → "status": "document.declined"

   Note: but if we restore it, we don’t receive any trigger.

Test trigger events for Document Decline

1. "event": "document_state_changed" → "status": "document.declined"

   

Cards related to WebHook

1. For document_state_changed event

   • status uploaded = "document.uploaded": it is not received for the webhook it is the state for documents created
   • status draft = "document.draft": the document is ready or was modified
     • The document is ready:
       • Update the status in the document.
       • we need to send the email to the 1st signer (or we want to send to all signers). (Application and Employee)
       • Do we need to emit a segment event? (Application and Employee)
       • Do we need to change the application status? (Application)
       • Do we need to add this event to the activity log? (Application)
     • The document was modified: Pending investigation and test.
   • status sent = "document.sent"
     • Update the status in the document.
     • We need to change the status to Ready to Sign. (Application)
     • Do we need to emit a segment event? (Application and Employee)
     • Do we need to add this event to the activity log? (Application)
   • status viewed = "document.viewed"
     • Update the status in the document.
     • Do we need to emit a segment event? (Application and Employee)
     • Do we need to add this event to the activity log? (Application)
   • status completed = "document.completed"
     • Update the status in the document.
     • We need to change the status to Document Completed. (Application)
     • Do we need to emit a segment event? (Application and Employee)
     • Do we need to add this event to the activity log? (Application)
   • status declined = "document.declined"
     • Update the status in the document.
     • Do we need to emit a segment event? (Application and Employee)
     • Do we need to add this event to the activity log? (Application)
     • Do we need to change the applicant status? (Application)
     • Do we need to send a notification to the recruiter?
       • If this was created by workflows?

2. For document_updated event

   • status draft = "document.draft": this can happen when the document is modified
     • Update the status in the document.
     • how do we want to manage this?
     • Do we need to emit a segment event? (Application and Employee)
     • Do we need to change the applicant status? (Application)
     • Do we need to add this event to the activity log? (Application)

3. For recipient_completed event

   • viewed = "document.viewed"
     • We need to update the signer records.
       • We need to check if the document is waiting for 2nd signer. (Application)
         • Update the status to ready for 2nd signer.
     • Do we need to emit a segment event? (Application and Employee)
     • Do we need to add this event to the activity log? (Application)

4. For document_deleted event

5. For document_creation_failed event

6. Monitoring?