# Wealthbox (/integrations/wealthbox)



{/* MANUAL-CONTENT-START:intro */}

Use [Wealthbox](https://www.wealthbox.com/) 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](/integrations/wealthbox-service-account). Each credential uses the connected Wealthbox user's permissions. Contact writes create new contacts; note and task writes also support updates.

{/* MANUAL-CONTENT-END */}

Connection guides: [API access tokens](/integrations/wealthbox-service-account).

## OAuth scopes [#oauth-scopes]

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](/platform/self-hosting/integrations-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 |

## Use the block [#usage-instructions]

Read or write Wealthbox notes, contacts, and tasks with OAuth or a supported API access token.

## Actions [#actions]

### Read Wealthbox Note [#read-wealthbox-note]

Read content from a Wealthbox note

#### Input [#input]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `noteId` | string | No | The ID of the note to read (e.g., "11111") |

#### Output [#output]

| 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) |

### Write Wealthbox Note [#write-wealthbox-note]

Create or update a Wealthbox note

#### Input [#input-1]

| 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") |

#### Output [#output-1]

| 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 Wealthbox Contact [#read-wealthbox-contact]

Read content from a Wealthbox contact

#### Input [#input-2]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `contactId` | string | No | The ID of the contact to read (e.g., "12345") |

#### Output [#output-2]

| 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) |

### Write Wealthbox Contact [#write-wealthbox-contact]

Create a new Wealthbox contact

#### Input [#input-3]

| 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 |

#### Output [#output-3]

| 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 Wealthbox Task [#read-wealthbox-task]

Read content from a Wealthbox task

#### Input [#input-4]

| Parameter | Type | Required | Description |
| - | - | - | - |
| `taskId` | string | No | The ID of the task to read (e.g., "67890") |

#### Output [#output-4]

| 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) |

### Write Wealthbox Task [#write-wealthbox-task]

Create or update a Wealthbox task

#### Input [#input-5]

| 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 |

#### Output [#output-5]

| 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) |