Service Order Resource Events
The Service Order resource is for service orders with a third-party mortgage service provider via Encompass Partner Connect. The following events are supported by the Webhook API for the serviceOrder resource:
Service Order events are limited to orders via Encompass Partner Connect (EPC)
Service Order events are only sent when a service is ordered using Encompass Partner Connect. The events listed below will not be sent if the service request is made outside of Encompass Partner Connect.
| Event | Description | Support |
|---|---|---|
| Placed | When a service order is delivered to the third-party service provider. Extra payload is included in the webhook notification. See the Service Order Extra Payload Contract Attributes for details. | Encompass Partner Connect |
| Acknowledged | When a service order is acknowledged by the third-party service provider. Extra payload is included in the webhook notification. See the Service Order Extra Payload Contract Attributes for details. | Encompass Partner Connect |
| Fulfilled | When an order is completed and the response is successfully ingested into Encompass. Extra payload is included in the webhook notification. See the Service Order Extra Payload Contract Attributes for details. | Encompass Partner Connect |
| System Failure | When a system exception (API failure) occurred while attempting to prepare the order request. Extra payload is included in the webhook notification. See the Service Order Extra Payload Contract Attributes for details. | Encompass Partner Connect |
| Process Failure | When a process exception (e.g., business rule, authorization, access, etc.) occurred while attempting to prepare the order request. Extra payload is included in the webhook notification. See the Service Order Extra Payload Contract Attributes for details. | Encompass Partner Connect |
Service Order Extra Payload Contract Attributes
The extra payload attributes are added with the 24.2 release of Encompass. The documentation is currently in-progress and will be finalized by August 17th, 2024.
The following attributes are sent as part of the extra payload for the Service Order webhook resource. The extra payload is applicable to all events supported by the Service Order webhook.
| Attribute | Description |
|---|---|
| partnerId string | The unique identifier of the EPC partner. |
| productId string | The unique identifier of the EPC partner product. |
| productListingName string | The name of the product as listed by the EPC partner. |
Notification Message
{
"eventId": "e173e4f1-0b75-4820-9338-82509667f03c",
"eventTime": "2024-04-05T18:11:52.000Z",
"eventType": "fulfilled",
"meta": {
"resourceType": "ServiceOrder",
"resourceId": "88f0e5fe-b160-4786-8138-6038e9c1759d",
"instanceId": "debe11136164",
"payload": {
"partnerId": "xxxxxxx",
"productId": "xxxxxxxxxx",
"productListingName": "Sample EPC product",
},
"resourceRef": "/encompass/v3/loans/{loanId}/serviceOrders/{serviceOrderId}/history/{eventId}"
}
}
Transaction Resource Events
The transaction resource events notify the webhook subscriber when an event occurs on an EPC transaction.
The Transaction Resource is available for EPC partners only.
Please see Encompass Partner Connect for instructions how to subscribe to this webbook.
Back to Webhooks Overview
© ICE Mortgage Technology, Inc. All rights reserved.