Webhook Access Controls
Only users authorized to create webhook subscriptions can manage the webhook subscriptions they create using the Update Subscription API. For example, ISV Partners who are subscribing to webhook events can only update the subscriptions they have created. One ISV Partner cannot update a subscription created by another ISV Partner or Lender.
One exclusion is that Encompass Admins can update/delete any webhook subscription for their Encompass instance including partner subscriptions.
Persona Settings
API Users that are not Encompass Admins must be granted one, or both, of the Persona settings noted below to create new webhook subscriptions.
By default, Encompass Admins can subscribe to any webhook event, Persona settings for webhook subscription does not apply to Administrators.
| Persona Setting | Description |
|---|---|
| Subscribe to Webhook | Allows API users to subscribe to all webhooks, except for the "Enhanced Field Change" webhook event. |
| Enhanced Field Change | Includes “Subscribe to Webhook” entitlements. Also, allows API users to subscribe to “Enhanced Field Change” webhooks. Please note - Enhanced Field Change webhook event is released in limited availability, available to all customers in a future release. |
Important!
Use caution when determining which non-admin Personas should have Webhook subscription access, especially Enhanced Field Change since it provides loan-level data, including PII. Use the Enhanced Field Change Personas option to limit access to the data to only select users and partners who have a true business need to access the detailed change data.
© ICE Mortgage Technology, Inc. All rights reserved.