Report Webhook Events
Overview
Webhooks are sent throughout the generation process for reports within Credit Decisioning. Webhooks will typically alert you when a report has started the process, when a report has had updates, when a report has failed to generate, or when a report has finished the generation process. Webhooks are generated when the callBackUrl is specified on the Generate call for the report. All callBackUrls must be HTTPS.
POST
/decisioning/v1/customers/{customerId}/voa?callbackUrl=https%3A%2F%2Fwww.mydomain.com%2FfinicityReports%2Flistener
The content type of the body of the webhook will match Accept type of the Generate report call (application/json, application/xml).
Webhooks will only be sent once. There is no retry policy. Webhooks require that the endpoint being called not have any security restrictions.
In addition, webhooks should be processed immediately. Any processing of webhook data must happen on another thread.
Event Body
The general format of the webhook body will contain the following fields:
| Field | Description |
|---|---|
| eventName | The event name of the webhook. This will either be inProgress, failed, primaryFieldUpdate, or done. |
| id | Finicity’s report ID |
| consumerId | Finicity’s consumer ID. This field is optional and may not always return. |
| consumerSsn | The last four of the consumer’s social security number. This field is optional and may not always return. |
| type | Finicity’s report type. This field is optional and may not always return. |
| status | inProgress, success, failure, or editing |
| customerId | Finicity’s customer ID. This field is optional and may not always return. |
| portfolioId | Finicity’s portfolio ID. This field is optional and may not always return. |
Event Types
Every report webhook event type that the partner will receive is listed below.
Some events aren’t applicable for certain types of Finicity Connect. The following table will direct you to which ones are applicable for the flow you are utilizing.
| Event Type | voa | voaHistory | voi | preQualVoa | voieTxVerify | payStatement |
|---|---|---|---|---|---|---|
| inProgress | X | X | X | X | X | X |
| failed | X | X | X | X | X | X |
| primaryFieldUpdate | X | X | ||||
| done | X | X | X | X |
In Progress
The inProgress webhooks are sent when a report has been generated.
{
"id":"reportId",
"eventName": "inProgress",
"consumerId": "conId",
"consumerSsn": "conSSN",
"type": "reportType",
"status": "inProgress",
"customerId": 123,
"portfolioId": "asdf-1-port"
} Failed
The failed webhooks are sent when a report has failed generation.
{
"id":"reportId",
"eventName": "failed",
"consumerId": "conId",
"consumerSsn": "conSSN",
"type": "reportType",
"status": "failure",
"customerId": 123,
"portfolioId": "asdf-1-port"
} Primary Field Update
The primaryFieldUpdate webhooks are sent when a VOIE report has gone through primary field extraction.
{
"id":"reportId",
"eventName": "primaryFieldUpdate",
"consumerId": "conId",
"consumerSsn": "conSSN",
"type": "reportType",
"status": "success",
"customerId": 123,
"portfolioId": "asdf-1-port"
} Done
The done webhooks are sent when a report has successfully generated.
{
"id":"reportId",
"eventName": "done",
"consumerId": "conId",
"consumerSsn": "conSSN",
"type": "reportType",
"status": "success",
"customerId": 123,
"portfolioId": "asdf-1-port"
}