How to Obtain API Endpoint Credentials for WealthEngine :

Product: Omatic Cloud

Description: This solution presents instructions on obtaining your API endpoint credentials

Environment: WealthEngine

Versions: All

Answer:

Required Inputs:
1. API Key - this is generated through the developer portal https://apikey.wealthengine.com/#/login

You can generate Sandbox or Production API Keys from the developer portal. Sandbox key should only be used for testing since it will only return you dummy data.

Environment (Sandbox/ Production)

If you want to just do some testing on dummy data you can use the Sandbox option. This will allow you to play with WE connector without any cost issues with the API. Select Production to work with real data. There is also cost involved with the number of production API hits.

Required Data/ fields:
1. WE requires first name, last name, email and address fields for proper matching. We have to send these fields to WE connector.

Workflow:
1. WE connector has a 2 Step workflow

i. Step1: Send data from BBCRM to WE connector. We need to create one formula to send data from BBCRM to WE connector. WE connector will search for matches in WE and save the data to a persistent storage.

ii. Step2: Send processed data back from WE to BBCRM. The data present in WE connector would be updated with additional information from WE. Hence we need to create another formula to send this updated data to BBCRM.

Formula Types:
1. There are 4 formula types per CRM:

i. CRM to WE Basic Profile:

This formula will send contacts data to WE connector. WE connector will then look for matches in WE and store the matched results in permanent storage. The purpose of this formula is only to receive records from CRM, look for a Basic Profile match in WE and store the matched data with the records in permanent storage.

ii. WE Basic Profile to CRM:

This formula will send processed records (Basic profile) from WE connector to CRM. The processed records will contain CRM ID, wealth score, income, net worth, real estate value, age, gender, gifting capacity, annual donations, etc. This information will then be updated in the CRM using the CRM ID. Once these processed records are retrieved from WE connector they are immediately deleted from the storage.

iii. CRM to WE Full Profile:

This formula will send contacts data to WE connector. WE connector will then look for matches in WE and store the matched results in permanent storage. The purpose of this formula is only to receive records from CRM, look for a Full Profile match in WE and store the matched data with the records in permanent storage. The difference between Basic profile and Full profile is that Full profile will have more data fields than the Basic profile.

iv. WE Full Profile to CRM:

This formula will send processed records (Full profile) from WE connector to CRM. The processed records will contain CRM ID, marital status, emails, relations, wealth score, income, net worth, cash in hand, businesses, stocks, assets, pensions, locations, real estate value, age, gender, gifting capacity, annual donations, vehicles, jobs, affiliations, charitable donations, political donations, etc. This information will then be updated in the CRM using the CRM ID. Once these processed records are retrieved from WE connector they are immediately deleted from the storage.