Connect Webhooks

Webhook events are sent during a Connect session as the customer interacts with the application. You can track progress through a session, get information about customer usage, and receive notifications when certain processes are complete.
Event Body
All events include a wrapper that contains metadata. The event data is within the payload key. If you specified custom events via the webhookData parameter when generating a connect url, they will be visible within the webhookData key.
JSON
{
  "customerId":"12345678",
  "consumerId":"ed81281fcec7ec557aa7d292a3188b75",
  "eventType":"started",
  "eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
  "payload":{
    "event data will be here"
  },
  "webhookData": {
    "custom event data will be here"
  }
}  
{
  "customerId":"12345678",
  "consumerId":"ed81281fcec7ec557aa7d292a3188b75",
  "eventType":"started",
  "eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
  "payload":{
    "event data will be here"
  },
  "webhookData": {
    "custom event data will be here"
  }
}  
﻿
Connect Events List
1) accountsDeleted
Name
Connect Support
Supported Processes
Description
accountsDeleted
Generate Connect Full
VOA, VOI, Aggregation, ACH
Sent when the specified accounts were deleted for the customer.
JSON
{
  "customerId": "1008650161",
  "eventType": "accountsDeleted",
  "eventId": "1594221522744-83455a87160c45b897058b04",
  "payload": {
    "accounts": [
      "1024371952"
    ]
  }
}

{
  "customerId": "1008650161",
  "eventType": "accountsDeleted",
  "eventId": "1594221522744-83455a87160c45b897058b04",
  "payload": {
    "accounts": [
      "1024371952"
    ]
  }
}
﻿
2) added
Name
Connect Support
Supported Processes
Description
added
Generate Connect Full
VOA, VOI, Aggregation, ACH
Sent after the customer lands on the eligible accounts page, and selects the accounts they want to submit for their loan. The accounts are saved in the account’s resource associated with the customer.
JSON
  {
    "customerId": "1017101354",
    "eventType": "added",
    "eventId": "1611877956869-28ebb24c66699bf3c77f04b1",
    "payload": {
      "accounts": [
        {
          "id": "1045121390",
          "number": "1000001111",
          "realAccountNumberLast4": "1111",
          "accountNumberDisplay": "1111",
          "name": "Checking",
          "balance": 128.52,
          "type": "checking",
          "aggregationStatusCode": 0,
          "status": "active",
          "customerId": "1017101354",
          "institutionId": "101732",
          "balanceDate": 1611877952,
          "aggregationSuccessDate": 1611877953,
          "aggregationAttemptDate": 1611877953,
          "createdDate": 1608197223,
          "lastUpdatedDate": 1611877956,
          "currency": "USD",
          "lastTransactionDate": 1611357151,
          "institutionLoginId": 1022599285,
          "detail": {
            "availableBalanceAmount": 122.12,
            "periodInterestRate": "4.5"
          },
          "displayPosition": 5
        },
        {
          "id": "1045121391",
          "number": "1000002222",
          "realAccountNumberLast4": "2222",
          "accountNumberDisplay": "2222",
          "name": "Savings",
          "balance": 128.52,
          "type": "savings",
          "aggregationStatusCode": 0,
          "status": "active",
          "customerId": "1017101354",
          "institutionId": "101732",
          "balanceDate": 1611877952,
          "aggregationSuccessDate": 1611877953,
          "aggregationAttemptDate": 1611877953,
          "createdDate": 1608197223,
          "lastUpdatedDate": 1611877956,
          "currency": "USD",
          "lastTransactionDate": 1608197228,
          "institutionLoginId": 1022599285,
          "detail": {
            "availableBalanceAmount": 1217.27,
            "periodInterestRate": "4.5"
          },
          "displayPosition": 6
        }
      ],
      "institutionId": "101732"
    }
  }
}

  {
    "customerId": "1017101354",
    "eventType": "added",
    "eventId": "1611877956869-28ebb24c66699bf3c77f04b1",
    "payload": {
      "accounts": [
        {
          "id": "1045121390",
          "number": "1000001111",
          "realAccountNumberLast4": "1111",
          "accountNumberDisplay": "1111",
          "name": "Checking",
          "balance": 128.52,
          "type": "checking",
          "aggregationStatusCode": 0,
          "status": "active",
          "customerId": "1017101354",
          "institutionId": "101732",
          "balanceDate": 1611877952,
          "aggregationSuccessDate": 1611877953,
          "aggregationAttemptDate": 1611877953,
          "createdDate": 1608197223,
          "lastUpdatedDate": 1611877956,
          "currency": "USD",
          "lastTransactionDate": 1611357151,
          "institutionLoginId": 1022599285,
          "detail": {
            "availableBalanceAmount": 122.12,
            "periodInterestRate": "4.5"
          },
          "displayPosition": 5
        },
        {
          "id": "1045121391",
          "number": "1000002222",
          "realAccountNumberLast4": "2222",
          "accountNumberDisplay": "2222",
          "name": "Savings",
          "balance": 128.52,
          "type": "savings",
          "aggregationStatusCode": 0,
          "status": "active",
          "customerId": "1017101354",
          "institutionId": "101732",
          "balanceDate": 1611877952,
          "aggregationSuccessDate": 1611877953,
          "aggregationAttemptDate": 1611877953,
          "createdDate": 1608197223,
          "lastUpdatedDate": 1611877956,
          "currency": "USD",
          "lastTransactionDate": 1608197228,
          "institutionLoginId": 1022599285,
          "detail": {
            "availableBalanceAmount": 1217.27,
            "periodInterestRate": "4.5"
          },
          "displayPosition": 6
        }
      ],
      "institutionId": "101732"
    }
  }
}
﻿
3) adding
Name
Connect Support
Supported Processes
Description
adding
Generate Connect Full
VOA, VOI, Aggregation, ACH
Sent when a customer enters their sign-in information at a financial institution and selects which accounts Connect can access to verify their financial information.
JSON
{
  "customerId": "7065940",
  "eventType": "adding",
  "eventId": "1572413263805-b43cb6edb3254d4bebcfb4a0",
  "payload": {
    "institutionId": "102224",
    "oauth": true
  }
}
{
  "customerId": "7065940",
  "eventType": "adding",
  "eventId": "1572413263805-b43cb6edb3254d4bebcfb4a0",
  "payload": {
    "institutionId": "102224",
    "oauth": true
  }
}
﻿
4) credentialsUpdated
Name
Connect Support
Supported Processes
Description
credentialsUpdated
Generate Connect Full / OAuth not supported
VOA, VOI, Aggregation, ACH
Sent when the customer updates their sign-in information for a selected institution. The mfa field indicates whether the credential challenge was followed by a sequential true or false MFA challenge question.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "credentialsUpdated",
  "eventId": "1559073542901-f2d2ebd11cf852a8114b54dc",
  "payload": {
    "institutionId": "101732",
    "mfa": false
  }
}

{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "credentialsUpdated",
  "eventId": "1559073542901-f2d2ebd11cf852a8114b54dc",
  "payload": {
    "institutionId": "101732",
    "mfa": false
  }
}
﻿
5) discovered
Name
Connect Support
Supported Processes
Description
discovered
Generate Connect Full / OAuth not supported
VOA, VOI, Aggregation, ACH
Sent after the customer has successfully signed in to an institution. All the customer’s eligible accounts to permission are included in this event. The accounts in the payload of the subsequently added event are a subset of the accounts in the discovered event. If no accounts were discovered, then an empty array is sent.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "discovered",
  "eventId": "1543509870615-7db10ceac8b2f5fa9b7b078c",
  "payload": {
    "accounts": [
      "...",
      "..."
    ]
  }
}

{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "discovered",
  "eventId": "1543509870615-7db10ceac8b2f5fa9b7b078c",
  "payload": {
    "accounts": [
      "...",
      "..."
    ]
  }
}
﻿
6) done
Name
Connect Support
Supported Processes
Description
done
Generate Connect Full / Connect Full – Joint Borrowers / Fix
VOA, VOI, Aggregation, ACH
The done event is sent after the customer clicks Submit at the end of a Connect experience.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "done",
  "payload": {}
}
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "done",
  "payload": {}
}
﻿
7) institutionNotFound
Name
Connect Support
Supported Processes
Description
institutionNotFound
Generate Connect Full / Fix
VOA, VOI, Aggregation, ACH
Sent when the user searches for an institution that is not on our list. Connect provides the description for the query field.
JSON
{
  "customerId": "29272504",
  "eventType": "institutionNotFound",
  "eventId": "1564677197519-4f47b664bd855275389e76c6",
  "payload": {
    "query": "not a real institution"
  }
}
{
  "customerId": "29272504",
  "eventType": "institutionNotFound",
  "eventId": "1564677197519-4f47b664bd855275389e76c6",
  "payload": {
    "query": "not a real institution"
  }
}
﻿
8) institutionNotSupported
Name
Connect Support
Supported Processes
Description
institutionNotSupported
Generate Connect Full / Fix
VOA, VOI, Aggregation, ACH
Sent when the user selects an institution that isn’t certified. This applies to any call except for aggregation, fix, and voi-pp.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "institutionNotSupported",
  "eventId": "1543535415162-6d06cbeed93533d612b4e255",
  "payload": {
    "institutionId": "15880"
  }
}
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "institutionNotSupported",
  "eventId": "1543535415162-6d06cbeed93533d612b4e255",
  "payload": {
    "institutionId": "15880"
  }
}
﻿
9) institutionSupported
Name
Connect Support
Supported Processes
Description
institutionSupported
Generate Connect Full
VOA, VOI, Aggregation, ACH
Sent when a user selects a financial institution from a search query that is certified for the product.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "institutionSupported",
  "eventId": "1557155470294-f5e5273c2354e09670647e18",
  "payload": {
    "institutionId": "101732"
  }
}
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "institutionSupported",
  "eventId": "1557155470294-f5e5273c2354e09670647e18",
  "payload": {
    "institutionId": "101732"
  }
}
﻿
10) invalidCredentials
Name
Connect Support
Supported Processes
Description
invalidCredentials
Generate Connect Full / OAuth not supported
VOA, VOI, Aggregation, ACH
Sent when the user enters incorrect sign-in information for the selected institution.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "invalidCredentials",
  "eventId": "1543535972345-805ba937fdc4c6d3889b261c",
  "payload": {
    "institutionId": "101732"
  }
}
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "invalidCredentials",
  "eventId": "1543535972345-805ba937fdc4c6d3889b261c",
  "payload": {
    "institutionId": "101732"
  }
}
﻿
11) mfa
Name
Connect Support
Supported Processes
Description
mfa
Generate Connect Full / OAuth not supported
VOA, VOI, Aggregation, ACH
Sent when the user enters correct sign-in information for an institution and a Multi-Factor Authorization (MFA) challenge question displays.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "mfa",
  "eventId": "1543535689086-56219127a30d3f881436c0b2",
  "payload": {
    "institutionId": "101732"
  }
}
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "mfa",
  "eventId": "1543535689086-56219127a30d3f881436c0b2",
  "payload": {
    "institutionId": "101732"
  }
}
﻿
12) mfaUpdated
Name
Connect Support
Supported Processes
Description
mfaUpdated
Generate Connect Full / OAuth not supported
VOA, VOI, Aggregation, ACH
Sent when the user completed the Multi-Factor Authorization (MFA) challenge question for an institution.
JSON
{
  "customerId": "7065940",
  "eventType": "adding",
  "eventId": "1572413263805-b43cb6edb3254d4bebcfb4a0",
  "payload": {
    "institutionId": "102224",
    "oauth": true
  }
}
{
  "customerId": "7065940",
  "eventType": "adding",
  "eventId": "1572413263805-b43cb6edb3254d4bebcfb4a0",
  "payload": {
    "institutionId": "102224",
    "oauth": true
  }
}
﻿
13) ping
Name
Connect Support
Supported Processes
Description
ping
Generate Connect Full / Connect Full – Joint Borrowers
VOA, VOI, Aggregation, ACH
Sent when the Generate Connect URL APIs are called to verify that the webhook URL is accessible. This endpoint must return a 200 series or the Generate Connect URL call fails.
JSON
{
  "eventType": "ping",
  "Payload": []
}
{
  "eventType": "ping",
  "Payload": []
}
﻿
14) processing
Name
Connect Support
Supported Processes
Description
processing
Generate Connect Full / Fix
VOA, VOI, Aggregation, ACH
Sent when a request to generate a report is in the process of generating the report. OAuth: Sent after the user selects their accounts from an OAuth connection, and then gets redirected back to Connect. This event indicates that the processing is ongoing for the selected processes, such as generating a report or handling OAuth authorization flow.
JSON
{
  "customerId": "7065940",
  "eventType": "processing",
  "eventId": "1567184715231-20b2b26125f0e7ada97395cb",
  "Payload": {
    "institutionId":"102224"
  }
}
{
  "customerId": "7065940",
  "eventType": "processing",
  "eventId": "1567184715231-20b2b26125f0e7ada97395cb",
  "Payload": {
    "institutionId":"102224"
  }
}
﻿
15) started
Name
Connect Support
Supported Processes
Description
started
Generate Connect Full / Connect Full – Joint Borrowers
VOA, VOI, Aggregation, ACH
Sent when the Connect application is loaded and the landing web page is displayed.
JSON
{
  "customerId": "1013916100",
  "consumerId": "06a46d02b9851829ca53946be1da8200",
  "eventType": "started",
  "eventId": "1602695997415-9acf8c53accecf433bc8b000",
  "payload": {}
}
{
  "customerId": "1013916100",
  "consumerId": "06a46d02b9851829ca53946be1da8200",
  "eventType": "started",
  "eventId": "1602695997415-9acf8c53accecf433bc8b000",
  "payload": {}
}
﻿
16) unableToConnect
Name
Connect Support
Supported Processes
Description
unableToConnect
Generate Connect Full / Connect Full – Joint Borrowers
VOA, VOI, Aggregation, ACH
Sent when a financial institution is unavailable (for unknown reasons) and a connection isn’t possible. This event indicates that the connection attempt has failed due to the unavailability of the institution.
JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "unableToConnect",
  "eventId": "1543535415162-6d06cbeed93533d612b4e255",
  "payload": {
    "institutionId": "15880",
    "code": 500
  }
}
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "unableToConnect",
  "eventId": "1543535415162-6d06cbeed93533d612b4e255",
  "payload": {
    "institutionId": "15880",
    "code": 500
  }
}
﻿
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

Name	Connect Support	Supported Processes	Description
accountsDeleted	Generate Connect Full	VOA, VOI, Aggregation, ACH	Sent when the specified accounts were deleted for the customer.

Name	Connect Support	Supported Processes	Description
added	Generate Connect Full	VOA, VOI, Aggregation, ACH	Sent after the customer lands on the eligible accounts page, and selects the accounts they want to submit for their loan. The accounts are saved in the account’s resource associated with the customer.

Name	Connect Support	Supported Processes	Description
adding	Generate Connect Full	VOA, VOI, Aggregation, ACH	Sent when a customer enters their sign-in information at a financial institution and selects which accounts Connect can access to verify their financial information.

Name	Connect Support	Supported Processes	Description
credentialsUpdated	Generate Connect Full / OAuth not supported	VOA, VOI, Aggregation, ACH	Sent when the customer updates their sign-in information for a selected institution. The mfa field indicates whether the credential challenge was followed by a sequential true or false MFA challenge question.

Name	Connect Support	Supported Processes	Description
discovered	Generate Connect Full / OAuth not supported	VOA, VOI, Aggregation, ACH	Sent after the customer has successfully signed in to an institution. All the customer’s eligible accounts to permission are included in this event. The accounts in the payload of the subsequently added event are a subset of the accounts in the discovered event. If no accounts were discovered, then an empty array is sent.

Name	Connect Support	Supported Processes	Description
done	Generate Connect Full / Connect Full – Joint Borrowers / Fix	VOA, VOI, Aggregation, ACH	The done event is sent after the customer clicks Submit at the end of a Connect experience.

Name	Connect Support	Supported Processes	Description
institutionNotFound	Generate Connect Full / Fix	VOA, VOI, Aggregation, ACH	Sent when the user searches for an institution that is not on our list. Connect provides the description for the query field.

Name	Connect Support	Supported Processes	Description
institutionNotSupported	Generate Connect Full / Fix	VOA, VOI, Aggregation, ACH	Sent when the user selects an institution that isn’t certified. This applies to any call except for aggregation, fix, and voi-pp.

Name	Connect Support	Supported Processes	Description
institutionSupported	Generate Connect Full	VOA, VOI, Aggregation, ACH	Sent when a user selects a financial institution from a search query that is certified for the product.

Name	Connect Support	Supported Processes	Description
invalidCredentials	Generate Connect Full / OAuth not supported	VOA, VOI, Aggregation, ACH	Sent when the user enters incorrect sign-in information for the selected institution.

Name	Connect Support	Supported Processes	Description
mfa	Generate Connect Full / OAuth not supported	VOA, VOI, Aggregation, ACH	Sent when the user enters correct sign-in information for an institution and a Multi-Factor Authorization (MFA) challenge question displays.

Name	Connect Support	Supported Processes	Description
mfaUpdated	Generate Connect Full / OAuth not supported	VOA, VOI, Aggregation, ACH	Sent when the user completed the Multi-Factor Authorization (MFA) challenge question for an institution.

Name	Connect Support	Supported Processes	Description
ping	Generate Connect Full / Connect Full – Joint Borrowers	VOA, VOI, Aggregation, ACH	Sent when the Generate Connect URL APIs are called to verify that the webhook URL is accessible. This endpoint must return a 200 series or the Generate Connect URL call fails.

Name	Connect Support	Supported Processes	Description
processing	Generate Connect Full / Fix	VOA, VOI, Aggregation, ACH	Sent when a request to generate a report is in the process of generating the report. OAuth: Sent after the user selects their accounts from an OAuth connection, and then gets redirected back to Connect. This event indicates that the processing is ongoing for the selected processes, such as generating a report or handling OAuth authorization flow.

Name	Connect Support	Supported Processes	Description
started	Generate Connect Full / Connect Full – Joint Borrowers	VOA, VOI, Aggregation, ACH	Sent when the Connect application is loaded and the landing web page is displayed.

Name	Connect Support	Supported Processes	Description
unableToConnect	Generate Connect Full / Connect Full – Joint Borrowers	VOA, VOI, Aggregation, ACH	Sent when a financial institution is unavailable (for unknown reasons) and a connection isn’t possible. This event indicates that the connection attempt has failed due to the unavailability of the institution.

Did this page help you?

Create bank connect journey link

Get Account ACH Details