Schedulers

Scheduler Service Resource Events

Scheduler Service supports loan manufacturing by providing ways to trigger events and automation based on the passage of time.  The Scheduler Service produces Webhook events for Created, Completed, Changed and Canceled loan-level schedulers.  Clients and partners can subscribe to receive these webhooks and use them to build out additional automation.

Usage Notes

Scheduler service webhook resource supports scheduled events in Encompass.
Schedulers can only be created based on configurations done in Encompass Admin Settings, either in Encompass Web or Desktop.
Loan-level events that create schedulers can be triggered from any source: Encompass Desktop, Encompass Web version, or via API.
In order to successfully generate the below webhook events, you must have an active Scheduler Template, as well as active companion Workflow Rules.
The Scheduler Template will provide rules for calculating the Completion date/time (“completionTime") of the Scheduler, based on data on the Encompass loan.
The Workflow Rules enable you to Start/Create a Scheduler, Cancel a Scheduler, or take action based on a Scheduler Completed Event.
Updates on the loan (completed in Encompass SC, Encompass Web, or via API) will trigger the creation of the Scheduler using the configurations mentioned above.

To learn more about the Scheduler Service, please see the Encompass Scheduler Best Practices Guide for more information.

Events

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

Event	Description	Support
Created	Scheduler event has been created. When a scheduler is started a “created” event will be generated. The “completionTime” in the payload indicates when the Scheduler “Completed” event will generated. This date/time is calculated using the Encompass Web Scheduler Template.	Smart Client, API
Completed	Scheduler event has been completed. This event is generated on the Scheduler “completionTime” date/time.	Smart Client, API
Changed	Scheduler event has been changed. When a Scheduler has been changed a “Changed” event will be generated. The “completionTime” that is sent in the “Changed” event may be different than the original “completionTime” that was sent by the “Created” event.	Smart Client, API
Cancelled	Scheduler event has been cancelled. When a scheduler is “Cancelled” before the “completionTime”, it means the “Completed” event will not generate.	Smart Client, API

Scheduler Payload Contract

ATTRIBUTE	DESCRIPTION
userId data type here	User who created the Scheduler. When created by Encompass Workflow Rule automation, then “Automation”.
resourceType string	The resource type. Note: For Schedulers, the resourceType will be “Timer” Enum: Timer
resourceId string	System generated unique id for the Scheduler.
instanceId string	Encomapss instance ID.
resourceRef string	The endpoint of the Scheduler. See Webhooks Subscription Contract Attributes.
name string	The name of the Scheduler Configuration template that was used to calculate the completionTime.
description string	The description of the Scheduler Configuration template that was used to calculate the completionTime.
associations array of objects	Data related to entities associated with the Scheduler. This is a one-to-many relationship. Includes the following types of relationships: - “loanguid” - the Encompass loan associated with the Scheduler. - “rule” - the Workflow Rule associated with creating, changing, or cancelling the Scheduler.
associations.entityId string	The unique Entity Id (GUID) of the association. - For “loanguid” relationship, this is the Encompass Loan Id (GUID). - For “rule” relationship, this is the Workflow Rule Id (GUID) that was used to either create, change, or cancel the Scheduler.
associations.entityType string	URN of the associated entity.
associations.relationship string	Relationship of the associated entity. Enums:: loanguid, rule
completionTime date/time	The date/time that the Scheduler will complete. This is when the “Completed” event will be created. The completionTime is calculated, using the rules configured in the Scheduler Configuration Template in Encompass Web.
created date/time	The date/time the Scheduler was created.
createdBy string	User who created the Scheduler. When created by Encompass Workflow Rule automation, then “Automation”.
lastUpdated date/time	The date/time the Scheduler was last updated.
lastUpdatedBy string	User who last updated the Scheduler. When created by Encompass Workflow Rule automation, then “Automation”.
status string	The status of the scheduler. Enums: active, cancelled, completed

The Scheduler Service webhook events will generate the following notification payload:

{ 
  "eventId": "6991ed8b-ef6c-438c-b7be-16ca250a8179", 
  "eventTime": "2024-02-13T02:32:03.000Z", 
  "eventType": "created", 
  "meta": { 
    "userId": "Automation", 
    "resourceType": "Timer", 
    "resourceId": "99c25467-85af-4fa5-8f19-f8223bbd0840:5f42675c-5731-4eb9-a6b9-1b5c4c34d1b7", 
    "instanceId": "be11226875", 
    "resourceRef": "v1/timers/99c25467-85af-4fa5-8f19-f8223bbd0840:5f42675c-5731-4eb9-a6b9-1b5c4c34d1b7", 
    "payload": { 
      "name": "Est Closing Date Minus 7 Reg-Z Days", 
      "description": "Scheduler configuration template description. This is a test", 
      "associations": [ 
        { 
          "entityId": "15d7e4f8-2f03-4b68-8f35-fe4fded81d4e", 
          "entityType": "urn:elli:service:workflow", 
          "relationship": "rule" 
        }, 
        { 
          "entityId": "99c25467-85af-4fa5-8f19-f8223bbd0840", 
          "entityType": "urn:elli:encompass:loan", 
          "relationship": "loanguid" 
        } 
      ], 
      "completionTime": "2024-02-13T02:35:00Z", 
      "created": "2024-02-13T02:32:03Z", 
      "createdBy": "Automation", 
      "lastUpdated": "2024-02-13T02:32:03Z", 
      "lastUpdatedBy": "Automation", 
      "status": "active" 
    } 
  } 
}

Back to Webhooks Overview