Best Practices for Using the Enhanced Field Change Webhook Event

Guide Table of Contents

• About Enhanced Field Change Events (EFC)
• Features and Usage Notes
• Access Controls to Enhanced Field Webhook Data
• Best Practices for Using the Enhanced Field Change Webhook Event
• How to Enable Enhanced Field Change Webhook Event

By subscribing to the Enhanced Field Change event, you will receive webhooks for every loan field change in their instance, the payload can be large and may span over multiple messages. It is recommended to implement a process on the client side to ingest and manage the data received in the payload.

It is best practice to limit your webhook subscription to 1 webhook per clientId (lender super admin, API user (aka ISV partner), and to implement routing logic on the client side to distribute the notification to the consuming clients.

🚧

Exercise caution when routing the Enhanced Field Change event to downstream clients as the webhook event includes PII data. Limit access to select users and partners who have a true business need to access the detailed change data.

Example - High Level Processing Flow for Receiving and Processing Webhook Events

1. Webhook Event Reception
   1. ICE Mortgage Technology sends a webhook event to a specified endpoint (webhook receiver).
   2. The endpoint authenticates and validates the event.
   3. The event is placed in a message queue (e.g. Kafka).
2. Event Processing
   1. A function reads events from the queue.
   2. The event is processed and stored in the database if needed. (e.g., for auditing).
   3. Routing logic determines which clients should receive the event.
3. Client Notification
   1. Publish the event to the relevant clients (e.g., using Websocket connections).