Clearmatch integration - notification

Clearmatch integration - notification

1.  Introduction

The purpose of this document is to provide a high-level explanation on how Clearmatch Notifications are used by a partner.          

A Clearmatch platform can be setup to send notifications when a certain “event” happens. For example, a partner might be interested in an application when a listing reaches the Posted status.  

For this process to work, the partner needs to have HTTP/JSON endpoint (aka Controller Service, Process Manager) on their infrastructure that can receive Clearmatch notifications. A Windows service on a Clearmatch platform monitors events in the platform and when an event of interest occurs, a notification message is sent to HTTP/JSON endpoint on the partner's platform.                  


2.  Partner Process Manager (aka Controller Service)

The Partner Process Manager (aka Controller service) is the HTTP/JSON endpoint where Clearmatch can send notifications to. Some design considerations include the following:
  • The Partner Process Manager must support basic authentication over SSL/TLS.
  • Any platform that can handle HTTP message can be used to build this software.
  • Must provide acknowledgement to a notification as soon as they are received. If any process needs to be done on the partner's side, they need to be performed after acknowledging the notification. Optionally, notifications can be stored in persistent storage for use by follow on processes.
  • If any acknowledgments are lost in transit, the notification is redelivered. Follow on processes have to consider this factor.  

3.  Clearmatch Notification Service

The Clearmatch Notification Service is a Windows service that delivers messages to the Partner Process Manager. Some of the key features include:
  1. The delivery of messages in an interval, as requested by the partner (the minimum interval is 30 seconds while the maximum interval is 23 hours).
  2. At least once delivery has occurred, the ability to handle transient failures and retry later is available.
  3. The ability to back off retries if the partner process manager is unavailable for a longer duration.  

3.1  Sample notification message

{
  "id":"A056035"
  "content": "https://demo-api.clearmatch.co/v1/UnsecuredLoans/application/A056035",
  "notificationType": "batchApplicationStatusChange",
  "partnerCode": "XXXXXXXX",
  "eventDescription": "",
  "eventTime": "2017-01-01T00:00:00"
}