Report Webhooks

Report webhook events are sent after you send a generate report API call. These notifications let you know the progress of the report you requested. Report events are sent when the report starts, updated, failed, and when it’s done generating.

To receive report webhooks Setup Report Listener service to listen for notifications. Then pass an HTTPS value for the callBackURL parameter in the generate report API call.

Sample VOA report webhook

POST



/decisioning/v1/customers/{customerId}/voa?callbackUrl=https%3A%2F%2Fwww.mydomain.com%2FfinicityReports%2Flistener




Note: Since report webhooks are sent only one time, we recommend processing the webhook data on a different thread as soon as it’s received.

Setup Report Listener

  1. Add an endpoint to receive our webhook events.
  2. Set the content type of the body to match the accept header used in the generate report call.
  3. Set the security on your endpoint to allow the HTTPS protocol.
  4. Test the endpoint locally to simulate externals in your application. We recommend testing with the URL: http://ngrok.com.
  5. Process the test request on a separate thread and return an HTTP 200 success response.
Sample webhook service
 @PostMapping(value = "/yourCallback", accepts = "application/xml") 
Sample node
 app.post('/yourCallback', bodyParser.raw({type:'application/json'}), (req, resp) => {};