Standard - Message Schema
The following attributes are sent with every webhook notification. With or without extra payload.
If the webhook supports extra payload, the payload details are sent in the payload.event object. For more details, see the message schema extra payload attributes for a given webhook event listed in the tables below.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| eventId string | Unique identifier for the event, which ensures events are only digested once. |
| eventTime datetime | The timestamp (ISO8601 format) of when the event occurred. |
| eventType string | The type of event that occurred. For example, possible values for loan resource are: Create, Update, Submit, Change, Move, Document, Milestone. |
| meta.userId string | The name of the user that generated this event. |
| meta.resourceType string | The type of resource this event that generated this event. |
| meta.resourceId string | The unique identifier of the resource this event is associated with (for example the loan GUID for the Loan resource). |
| meta.instanceId string | The unique identifier of the Encompass environment. |
| meta.resourceRef string | The URL of the resource. This can be used to fetch the full resource. |
© ICE Mortgage Technology, Inc. All rights reserved.