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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 { "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 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!