Stavvy SMARTeSign Push Notification (Webhook) Guide

LOGIN TO eSign

1. Go to https://www.smartenotary.com .  The Login screen appears

2. Enter your credentials and click LOGIN. Your eSign home page appears.

eSign Settings - Emails Tab

All Push Notifications (Webhooks) are defined by email templates, which can be accessed through the Settings page followed by the Emails tab.

 

Emails - Email Templates

Allows users the ability to select which email notifications they wish to enable. Select Edit to set up push notifications (webhooks). 

Emails - Edit Email Template

1. Email Notifications are configurable to use Push Notifications (Webhooks) based on the clients needs. Below is an example of  the email template for ‘ParticipantCompletedSigning’ The Push Notification toggle button is enabled to make the Push Notification active.

 

Emails - Test Push Notifications

The Push Notification (Webhook) URL is entered in the  field provided. The webhook URL can be any valid URL provided by the client as long as it's accessible to the internet, or example:

https://client.com/webhook/handleparticipantsigning

https://client.com/webhook?action=participantsigning

 The URL format is up to the client. The system will post the data to the URL provided. The information is saved when the user clicks the Update button.

Utilize the following website  to quickly assess what data is present for each Push Notification (Webhook): https://webhook.site/

 Copy the Unique URL  and paste it in the push notification field.

When the Email Notifications have been configured for the Push Notification (Webhook) the user can  trigger the action to initiate the Push Notification (Webhook).

 In the example above, we added the Push Notification (Webhook) for the ‘ParticipantCompletedSigning’ event. Once a participant signs within the system a Push Notification (Webhook) will be initiated. 

 The Push Notification (Webhook) below was initiated by the system and pushed to the https://webhook.site. This website can aid in understanding what data is present for each webhook triggered.

 Below is an example of the payload for the ParticipantCompletedSigning event:

{

  "Id": 0,

  "EventId": null,

  "EventType": 26,

  "EventTypeValue": "ParticipantSigningCompleted",

  "ClientId": 7,

  "SearchKey": "DP_Enote_Pkg_1716480611",

  "UserName": "[e-mail]",

  "EmailRecipients": [],

  "UseParticipantsAsRecipients": false,

  "DocumentName": "test-eNote-2-signers-A.xml",

  "DocumentId": 2224962,

  "DocumentGuid": null,

  "DocumentsUDF1": null,

  "EDeliveryFailed": false,

  "Participants": [

    {

      "ParticipantId": 234421,

      "ParticipantMappingId": 234248,

      "FullName": "Haifeng Mei",

      "FirstName": "Haifeng",

      "MiddleName": "",

      "LastName": "Mei",

      "EmailAddress": "[e-mail]",

      "MobileNumber": "",

      "ParticipantType": "Signer",

      "PackageStatus": null,

      "PackageAddress": null,

      "ParticipantStatus": "Package_Reviewed_And_Signed",

      "InvitationStatus": "Pending_Invitation",

      "ParticipantTypeId": 1,

      "ParticipantStatusId": 7,

      "InvitationStatusId": 1,

      "PackageId": 79339,

      "NotarizeId": 72059,

      "InvitationLink": "https://pp.smartenotary.com/direct/c08bbdbd-ee9c-4010-afa3-27309430e09d",

      "DateAdded": "2024-05-23T16:26:12.8787727Z",

      "AddedBy": 0,

      "AdminUserId": 0,

      "EvaultUserId": 134,

      "XMLBorrowerId": "xmlHM1",

      "SSN": null,

      "ApplicationUserId": 0,

      "RoleId": 0,

      "AutoSignFlag": false,

      "DateModified": null

    }

  ],

  "EventDate": null,

  "ClientName": "Evolve Client",

  "RecipientClientName": null,

  "SmartTRANSFERId": null,

  "ClientEmail": null,

  "ClientPhone": null,

  "Signers": null,

  "SigningType": "eSign",

  "LoanNumber": "DP_25042024_20",

  "SigningRoomName": "DP_Enote_Pkg_1716480611",

  "SigningRoomId": 79339,

  "SigningRoomExpirationDate": null,

  "SigningRoomCreatorName": null,

  "SigningRoomCreatorEmail": null,

  "SigningRoomComment": null,

  "SigningRoomAdminName": null,

  "EPackageUserName": null,

  "EPackageDocumentName": null,

  "MERSRequestorName": null,

  "MERSRequestorOrgId": null,

  "MERSRecipientOrgId": null,

  "MERSRecipientName": null,

  "MIN": null,

  "MERSRequestType": null,

  "MERSApprovalStatus": null,

  "MERSTrackingNumber": null,

  "MERSStatus": null,

  "MERSERegistryConfirmationType": null,

  "DocumentSendReceiveMessageId": null,

  "DocumentSendReceiveSender": null,

  "DocumentSendReceiveRecipient": null,

  "Url": "https://webhook.site/8e3ecea0-26c1-4264-9e15-4e43bd4352b6",

  "ActionEffectiveDate": null,

  "MERSTransferIdentifier": null,

  "RequestingPartyOrgId": null,

  "ErrorMessage": null,

  "RequestJSON": null,

  "ResponseJSON": null

}