Webhook Subscriptions

Suggest Edits

The flow for ordering document packages is mostly asynchronous so using webhooks is a good way to track the status. Creating a webhook subscription allows the Encompass platform to deliver real-time notifications to your application when a loan audit is created, and when documents are created, ordered, and delivered. These events and more are available for subscription on the DocumentOrder resource.

📘
Support for Webhooks
Note that webhooks for Send Encompass Docs are only supported via API.

Document Order Resource Events

Opening, Closing, and CD/LE workflows will publish a webhook notification upon completion of each step in the workflow. The following events are supported by the Webhook API for the documentOrder resource:

Event	Description
openingauditcompleted	When an opening document audit is completed.
openingauditfailed	When opening document audit fails.
openingordercompleted	When an opening document order is completed.
openingorderfailed	When an opening order fails.
openingdeliverycompleted	When opening documents are delivered successfully.
openingdeliveryfailed	When opening document delivery fails.
closingauditcompleted	When a closing audit is completed.
closingauditfailed	When a closing audit fails.
closingordercompleted	When a closing order is completed.
closingorderfailed	When a closing order fails.
closingdeliverycompleted	When closing documents are delivered successfully.
closingdeliveryfailed	When closing document delivery fails.
closingpackagecompleted	When a closing package fails.
closingpackagefailed	When a closing package fails.
formscompleted	When form delivery is completed.
formsfailed	When a form fails.
formsdeliverycompleted	When form delivery is completed.
formsdeliveryfailed	When form delivery fails.

Samples

Sample Webhook Subscription for Opening (Initial) Disclosures

{
    "endpoint": "https://requestb.in/usbniyus",
    "resource": "DocumentOrder",
    "events": [
        "openingauditcompleted",
        "openingauditfailed",
        "openingordercompleted",
        "openingorderfailed",
        "openingdeliverycompleted",
        "openingdeliveryfailed",
        "openingappenddocumentssucceeded",
        "openingappenddocumentsfailed"
    ]
}

Sample Webhook Subscription for Closing Disclosures

{
    "endpoint": "https://requestb.in/usbniy",
    "resource": "DocumentOrder",
    "events": [
        "closingauditcompleted",
        "closingauditfailed",
        "closingordercompleted",
        "closingorderfailed",
        "closingdeliverycompleted",
        "closingdeliveryfailed",
        "closingpackagecompleted",
        "closingpackagefailed"
    ]
}

Sample Webhook Subscription for On-Demand Forms

{
    "endpoint": "https://requestb.in/usbniyc",
    "resource": "DocumentOrder",
    "events": [
        "formscompleted",
        "formsfailed",
        "formsdeliverycompleted",
        "formsdeliveryfailed"
    ]
}

Updated 7 months ago

📘Support for Webhooks

Document Order Resource Events

Samples

📘
Support for Webhooks