vConnect Interface

All vConnect Events

Event Names and their Methods

Event names contained in the onMessage handler call methods that correspond to their name by prepending with "on" and using camel case. So, to execute code upon receipt of the launch event, use the onLaunch() method. The complete event uses the onComplete() method. Etc.

eventData object

Every event provides the eventData object in it's response.

eventData = {
    name: eventName,
    CONNECTComplete: bool,
    CONNECTType: string,
    inquiryId: guid,
    inquiryType: string,
    accountToken: guid,
    account: {
        bankId: int,
        bankName: string,
        accountType: string,
        accountNickname: string,
        last4Digits: string
    }
}

Client Side Events

Example client-side code that handles a few events

const CONNECT = new RIBBITConnect({
    target: 'ribbit', // id of any element within the </body> which you want vConnect to initialize within
    token: '{Session Token}', // see documentation on how to get a session token
});
CONNECT.open();
CONNECT.onExit((eventData) => {
    const message = { type: 'EXIT', eventData};
    console.log({message}); //window.ReactNativeWebView.postMessage(JSON.stringify(eventData))
    CONNECT.close();
});
CONNECT.onComplete((eventData) => {
    if(eventData && eventData.CONNECTComplete) {
        let inquiryType = eventData.inquiryType;
        let inquiryId = eventData.inquiryId;
        // Save these values to return insights results

        alert('Successfully linked to ' + eventData.account.bankName + ' (...' + eventData.account.last4Digits + ')');
    }
});

External Events (Webhooks)

You can configure vConnect to send events to your server securely. This method is preferred for recording account tokens, inquiry IDs, and other sensitive data, as this ensures the data stays out of the client's environment.

There are two ways to ensure that webhooks are set up for each session:

1. Provide a settings.webhookUrl to vConnect when initializing the session.
2. Enable webhooks in vConnect Settings and specify a URL to call. With this method, every session will use the same URL every time.

Events will include a sessionToken, which will reference the session in which the event was raised

We will send a POST message to the endpoint you specified in your widget settings. We expect a successful (200) response back. If we do not receive a successful response, we will repeat the call to your server once per hour, up to 24 times.

Example of what we will send to you

{
    "sessionToken": "vConnect Session Token",
    "eventDate": "2022-01-01T12:00:00.0000000Z",
    "eventName": "complete",
    "customerId": "Customer or Reference ID",
    "merchantId": 12345,
    "connectComplete": true,
    "connectType": "BankLOGIN",
    "inquiryId": "BankLOGIN+ (vInsightSync) InquiryID",
    "inquiryType": "BankLOGIN+",
    "account": {
        "bankId": 12345,
        "bankName": "Full Bank Name",
        "accountNickname": "Sample Checking Account",
        "accountType": "Checking",
        "accountToken": "00000000-xxxx-xxxx-xxxx-000000000000",
        "last4Digits": "1234"
    }
}