Use Wealthbox to read and write client notes, contacts, and tasks. A workflow can turn meeting output into a note, retrieve client context, or create follow-up work.
Connect with OAuth or a supported API access token. Each credential uses the connected Wealthbox user's permissions. Contact writes create new contacts; note and task writes also support updates.
Connection guides: API access tokens.
Sim requests these scopes when someone connects a Wealthbox account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.
| Setting | Value |
|---|
| Redirect URI | <NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/wealthbox |
| Environment variables | WEALTHBOX_CLIENT_ID, WEALTHBOX_CLIENT_SECRET |
| Scope | Description |
|---|
login | Access Wealthbox account |
data | Access Wealthbox data |
Read or write Wealthbox notes, contacts, and tasks with OAuth or a supported API access token.
Read content from a Wealthbox note
| Parameter | Type | Required | Description |
|---|
noteId | string | No | The ID of the note to read (e.g., "11111") |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Note data and metadata |
↳ content | string | Formatted note information |
↳ note | object | Raw note data from Wealthbox |
↳ metadata | object | Operation metadata |
↳ itemId | string | ID of the note |
↳ noteId | string | ID of the note |
↳ itemType | string | Type of item (note) |
Create or update a Wealthbox note
| Parameter | Type | Required | Description |
|---|
content | string | Yes | The main body of the note |
contactId | string | No | ID of contact to link to this note (e.g., "12345") |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created or updated note data and metadata |
↳ note | object | Raw note data from Wealthbox |
↳ success | boolean | Operation success indicator |
↳ metadata | object | Operation metadata |
↳ itemId | string | ID of the created/updated note |
↳ noteId | string | ID of the created/updated note |
↳ itemType | string | Type of item (note) |
Read content from a Wealthbox contact
| Parameter | Type | Required | Description |
|---|
contactId | string | No | The ID of the contact to read (e.g., "12345") |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Contact data and metadata |
↳ content | string | Formatted contact information |
↳ contact | object | Raw contact data from Wealthbox |
↳ metadata | object | Operation metadata |
↳ itemId | string | ID of the contact |
↳ contactId | string | ID of the contact |
↳ itemType | string | Type of item (contact) |
Create a new Wealthbox contact
| Parameter | Type | Required | Description |
|---|
firstName | string | Yes | The first name of the contact |
lastName | string | Yes | The last name of the contact |
emailAddress | string | No | The email address of the contact |
backgroundInformation | string | No | Background information about the contact |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created or updated contact data and metadata |
↳ contact | object | Raw contact data from Wealthbox |
↳ success | boolean | Operation success indicator |
↳ metadata | object | Operation metadata |
↳ itemId | string | ID of the created/updated contact |
↳ contactId | string | ID of the created/updated contact |
↳ itemType | string | Type of item (contact) |
Read content from a Wealthbox task
| Parameter | Type | Required | Description |
|---|
taskId | string | No | The ID of the task to read (e.g., "67890") |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Task data and metadata |
↳ content | string | Formatted task information |
↳ task | object | Raw task data from Wealthbox |
↳ metadata | object | Operation metadata |
↳ itemId | string | ID of the task |
↳ taskId | string | ID of the task |
↳ itemType | string | Type of item (task) |
Create or update a Wealthbox task
| Parameter | Type | Required | Description |
|---|
title | string | Yes | The name/title of the task |
dueDate | string | Yes | The due date and time of the task (format: "YYYY-MM-DD HH:MM AM/PM -HHMM", e.g., "2015-05-24 11:00 AM -0400") |
contactId | string | No | ID of contact to link to this task (e.g., "12345") |
description | string | No | Description or notes about the task |
| Parameter | Type | Description |
|---|
success | boolean | Operation success status |
output | object | Created or updated task data and metadata |
↳ task | object | Raw task data from Wealthbox |
↳ success | boolean | Operation success indicator |
↳ metadata | object | Operation metadata |
↳ itemId | string | ID of the created/updated task |
↳ taskId | string | ID of the created/updated task |
↳ itemType | string | Type of item (task) |