Document Delivery

This webhook added with the 24.2 release of Encompass.

Document Delivery Resource Events

Supports custom fulfillment and delivery APIs. Subscribing to this resource, lenders can receive a notification when a loan/disclosure package is posted for delivery by eClosing to be sent to borrowers and loan originators. The webhook notifications for the added webhook events include extra payload attributes enabling more efficient downstream processing.

The following events are supported by the Webhook API for the DocumentDelivery resource:

📘
The fulfillmentCreated and fulfillmentUpdated events are being released in limited availability. For additional information on these webhook events, please reach out to your support representative.

Event	Description	Support
packageCreated	When a package was created in eDelivery. This webhook event is triggered for all packages regardless if package with Fulfillment (indicator flag) is selected. Extra payload is included in this event. See the Extra Payload Contract Attributes for Package Events for details.	Smart Client, API
packageUpdated	When an eDelivery package was updated. Extra payload is included in this event. See the Extra Payload Contract Attributes for Package Events for details.	Smart Client, API
fulfillmentCreated	When a package is ready for fulfillment. Released in limited availability.	Smart Client, API
fulfillmentUpdated	When there are any changes to fulfillments. Released in limited availability.	Smart Client, API

Extra Payload Contract Attributes for Package Events

The following attributes are sent as part of the extra payload for the DocumentDelivery packageCreated and packageUpdated webhook events.

Attribute	Description
groupNamespace string	The group name.
groupId string	The group Id.
mediaStore string	The source of media storage. Example: Skydrive
fulfillmentScheduledDate date	The fulfillment scheduled date. Example: 2024-02-13T21:19:18.250Z
fulfillmentStatus string	The fullfillment status. Example: Posted
status string	The DocumentDelivery status. Example: PackageCreated
signedDate date	Signed date. Example: 2024-02-13T21:19:18.250Z
completedDate date	Completed date. Example: 2024-02-13T21:19:18.250Z
documentTypes enum (array of strings)	Supported values: ESign, WetSign, Needed, Information, InPersonWetSign
hasMoreRecipients boolean	Indicates if there are more recipients. Supported values: true/false
Recipients.consent.status String	Recipient consent status. Example: Accepted
Recipients.consent.date date	The date of the recipient consent. Example: 2024-02-13T21:19:18.250Z
Recipient.taskStatuses.taskType string	The type of task status. Example: ESign.
Recipients.taskStatuses.viewedDate date	The viewed date. Example: 2024-02-13T21:19:18.250Z
Recipients.taskStatuses.completedDate date	The completed date. Example: 2024-02-13T21:19:18.250Z

Notification Message

{
  "eventId": "96595cc5-3493-48f9-9019-16d23070bd09",
  "eventTime": "2024-06-13T20:08:16.509Z",
  "eventType": "packagecreated",
  "meta": {
    "resourceType": "DocumentDelivery",
    "resourceId": "39200291-d69d-47ec-8f22-3b520588043c",
    "instanceId": "debe11170913",
    "resourceRef": "/delivery/v3/loans/2c853676-2ae9-4f9c-8238-d2c704085552/packages/39200291-d69d-47ec-8f22-3b520588043c",
    "payload": {
      "groupNamespace": "loans",
      "groupId": "2c853676-2ae9-4f9c-8238-d2c704085552",
      "status": "Created",
      "mediaStore": "MediaVault",
      "documentTypes": [
        "Coversheet",
        "InPersonWetSign",
        "Information",
        "WetSign",
        "Needed",
        "ESign"
      ],
      "recipients": [
        {
          "recipientId": "86161cdd-76a9-480d-868c-a480a74a3c17",
          "consent": {
            "date": "2024-06-13T20:07:15.079Z",
            "status": "Accepted"
          },
          "taskStatuses": [
            {
              "taskType": "Review"
            },
            {
              "taskType": "WetSign"
            },
            {
              "taskType": "Upload"
            },
            {
              "taskType": "ESign"
            }
          ]
        }
      ],
      "hasMoreRecipients": false
    }
  }
}

{
  "eventTime": "2024-06-13T20:08:16.572Z",
  "eventId": "380c591c-d185-4d6f-97f0-a36152e5964a",
  "eventType": "packageupdated",
  "meta": {
    "resourceRef": "/delivery/v3/loans/2c853676-2ae9-4f9c-8238-d2c704085552/packages/39200291-d69d-47ec-8f22-3b520588043c",
    "resourceId": "39200291-d69d-47ec-8f22-3b520588043c",
    "instanceId": "debe11170913",
    "payload": {
      "groupNamespace": "loans",
      "recipients": [
        {
          "consent": {
            "date": "2024-06-13T20:07:15.079Z",
            "status": "Accepted"
          },
          "recipientId": "86161cdd-76a9-480d-868c-a480a74a3c17",
          "taskStatuses": [
            {
              "taskType": "Review"
            },
            {
              "taskType": "WetSign"
            },
            {
              "taskType": "Upload"
            },
            {
              "taskType": "ESign"
            }
          ]
        }
      ],
      "groupId": "2c853676-2ae9-4f9c-8238-d2c704085552",
      "documentTypes": [
        "Coversheet",
        "InPersonWetSign",
        "Information",
        "WetSign",
        "Needed",
        "ESign"
      ],
      "mediaStore": "MediaVault",
      "hasMoreRecipients": false,
      "status": "Created"
    },
    "resourceType": "DocumentDelivery"
  }
}