How to Enable 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

To enable the Enhanced Field Change webhook event for your Encompass instance, please see the following instructions:

Open a support ticket to request the feature through the Resource Center including the Instance ID where this feature must be enabled.
📘
This feature must first be enabled in your R2T instance.  Production enablement can happen only after you have successfully tested in R2T and communicated to Support via the same channel.
1. The feature will be enabled on a pre-determined change date, based on when the request is received. This information will be communicated through the support ticket.
Subscribe to the Enhanced Field Change webhook event via the self-serve Subscriptions API.
1. New subscribers to the loan resource event, or creating a new subscription for a different endpoint can use the Create a Subscription POST API call.
2. Existing subscribers to the loan resource webhook event that need to add the enhancedfieldchange as an additional webhook event to the loan resource for the same endpoint domain can update their subscription using the Update Subscription PUT API call.
  📘
  Subscribers to the EFC event will start receiving the notifications after the change has been implemented on the predetermined change date (as communicated in the support ticket).

Code Samples

curl --location 'https://api.elliemae.com/webhook/v1/subscriptions' \ 
--header 'Content-Type: application/json' \ 
--header 'Authorization: Bearer <access token>' \ 
--data '{ 
    "events": [ 
        "enhancedfieldchange" 
    ], 
    "endpoint": "<endpoint>", 
    "resource": "Loan", 
    "enableSubscription":true 
}'

curl --location --request PUT 'https://api.elliemae.com/webhook/v1/subscriptions/56d465e8-7777-4aa3-916b-d39827ed9b5b' \ 
--header 'Content-Type: application/json' \ 
--header 'Authorization: Bearer 0004sytZe2g6kXyDbt2QmDWMYUPX' \ 
--data '{ 
  "endpoint": "<endpoint url>", 
   "resource": "Loan", 
   "events": ["change", "enhancedfieldchange"], 
   "filters":{ 
    "attributes":[  
        "/applications/1/borrower/maritalStatusType", 
        "/applications/*/coborrower/equifaxScore", 
        "/contacts/3/*", 
        "/customFields/100/*" 
        ] 
    }, 
        "enableSubscription":true 
}

curl --location 'https://api.elliemae.com/webhook/v1/subscriptions' \ 
--header 'Content-Type: application/json' \ 
--header 'Authorization: Bearer 0004sytZe2g6kXyDbt2QmDWMYUPX' \ 
--data '{ 
    "events": [ 
        "enhancedfieldchange" 
    ], 
    "endpoint": "https://<endpoint url>", 
    "resource": "Loan", 
    "filters": { 
        "attributes": [ 
            "/customFields/*/stringValue", 
            "/applications/0/borrower/firstName" 
        ] 
    }, 
        "enableSubscription":true 
}'