1. Loan Servicing Setup Guide
  2. Appendix : Webhooks
  3. Processing Webhook Request

F.5 Processing Webhook Request

  • When an event is triggered in OFSLL, system checks if there are any Webhook actions defined for different channels.
  • If there are multiple registries available, OFSLL creates multiple WEBHOOK messages to propagate event details to the third-party applications.
  • WEBHOOK MDB reads the messages and generates response based on User Defined Table available for individual Events.
  • When response data is generated, system generates POST request to third-party applications and marks these requests as COMPLETED on successful notification.
  • If the third-party notification is failed, OFSLL updates the message as FAILED.
  • On receiving the notifications, OFSLL expects third-party application’s POST service to return one of the following HTTP status code:

    Table F-1 Processing Webhook Request

    HTTP Status Code MDB Dashboard Status Description
    2XX, 3XX COMPLETED  
    4XX FAILED Need to resubmit manually. MDB will update retry count to 5
    5XX FAILED Will be resubmitted by batch job
  • The system parameter EVI_MAX_RETRY_COUNT records and controls the maximum attempts to re-trigger FAILED Webhook requests which cannot exceed more than 5 times. However, this parameter can be modified if the maximum re-trigger attempts is to be less than 5 times.
  • The batch job EVEPRC_BJ_100_02 in SET-EVE batch job set picks the FAILED status messages for re-trigger and considers the above system parameter to control the maximum attempts to re-trigger.
  • The system parameter CMN_HTTP_CONNECTION_TIMEOUT determines the maximum allowed response time (in seconds) from the third-party application. If response time exceeds than the system parameter configured value, then the status of request is updated as FAILED with 500 HTTP Status Code.
  • If the system is running behind a firewall/proxy network, OFSLL provides below system parameters to configure proxy details.

    Table F-2 System Parameters

    System Parameter Description
    CMN_HTTP_PROXY_ENABLED_IND PROXY INDICATOR FOR ALL OUTSIDE HTTP/HTTPS CONNECTION
    CMN_HTTP_PROXY_PORT HTTP PROXY SERVER PORT FOR OUTGOING HTTP CONNECTIONS
    CMN_HTTP_PROXY_SERVER HTTP PROXY SERVER FOR OUTGOING HTTP CONNECTIONS

Parent topic: Appendix : Webhooks