Contracts

Webhook Event Attributes

The following attributes make up the Event contract object. All attributes are optional unless otherwise specified.

ATTRIBUTE	DESCRIPTION
event Payload object	Object containing the payload.
id string	The unique identifier of the event.
time string	The timestamp (ISO8601 format) of when the event occurred.
type string	The type of event.

Webhook Event Payload Attributes

The following objects and attributes make up the Payload contract object. All attributes are optional unless otherwise specified.

ATTRIBUTE	DESCRIPTION
clientId string	Unique identifier per client assigned by ICE Mortgage Technology. This is an optional field. It will be populated automatically based on authentication details.
eventId string	Unique identifier for the event, which ensures events are only digested once.
eventTime string	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, and Milestone.
ingressTime string	The delay or amount of time between receiving the event and processing the event.
instanceId string	Encompass instance ID.
resourceId string	The unique identifier of the resource this event is associated with (that is, the loan GUID).
resourceType string	The type of resource that generated this event.
status string	Possible values are: - EventReceived: Event is received by the webhook service. - SubscriptionMatched: Event is matched against a subscription. - NotificationDelivered: Notification is successfully delivered/acknowledged.
statusDetails string	Additional details about the webhook’s status.
subscriptionId string	The unique ID assigned to the subscription when it is created.
deliveryStatus string	Provides information how IMT received the response for webhooks requests. The deliveryStatus contains the http status code received for the webhook request. - If webhook request times out, then "timedout” is presented for DeliveryAttempted status. - If webhook request cannot resolve the endpoint host name, then “error” is presented for DeliveryAttempted status and statusDetail will have more information for DeliveryAttempted status.