Back

Wealthbox CRM API Essential Guide

Aug 14, 20246 minute read

What type of API does Wealthbox CRM provide?

Type of API

Wealthbox CRM has a REST API.

Key characteristics of the Wealthbox API:

  1. It is REST-based and uses JSON or XML for data exchange.
  2. It provides full read-write access to Wealthbox data.
  3. It uses HTTPS and requires authentication for every request.
  4. It supports cross-origin resource sharing (CORS).
  5. The API endpoint is https://api.crmworkspace.com.

Authentication

  • The API uses OAuth 2.0 for authentication.
  • It requires an API access token or OAuth 2.0 flow for authentication.

Does the Wealthbox CRM API have webhooks?

Webhooks Availability

The official Wealthbox CRM API does not appear to have native webhook support. The search results do not mention any built-in webhook functionality provided directly by Wealthbox CRM's API.

Alternative Integration Options

While native webhooks are not mentioned, there are several alternative ways to integrate with Wealthbox CRM:

  1. REST API: Wealthbox offers a REST-based API that allows developers to interact with Wealthbox data.

  2. Third-party Integration Platforms: Services like Integrately and Zapier offer ways to create custom integrations between Wealthbox CRM and other applications, including webhook-like functionality.

  3. OAuth Authentication: The API supports OAuth 2.0 for secure authentication and authorization.

API Capabilities

Although webhooks are not mentioned, the Wealthbox API offers various capabilities:

  • Retrieve, create, and edit contacts, tasks, events, notes, opportunities, and projects.
  • Retrieve CRM activity stream data.
  • Trigger CRM workflow notifications.
  • Run CRM reports and fetch results.
  • Retrieve various CRM-related data types.

Key Considerations

  1. The API uses a "documentation first" approach, ensuring that the API documentation is always up-to-date and consistent with the actual API behavior.

  2. The API provides full read-write access to Wealthbox data.

  3. While native webhooks are not available, developers can use the API to build integrations that achieve similar functionality.

In conclusion, while the official Wealthbox CRM API does not appear to offer native webhook support, it provides a comprehensive REST API that can be used to build integrations and automate workflows. Developers can also leverage third-party platforms to create webhook-like integrations if needed.

Rate Limits and other limitations

Here are the key points about the API Rate Limits for the Wealthbox CRM API:

Rate Limits

  • The Wealthbox API is subject to throttling based on the API access token being used.

  • The throttling rate is one request per second over a five minute sampling period.

  • Short bursts of activity above the threshold are permitted.

  • If you exceed the rate limit, a 429 status code is returned.

Plan-Specific Limits

According to one source, the rate limits for different plans are:

  • Free Plan: 100 API calls per day
  • Starter Plan: 1,000 API calls per day
  • Growth Plan: 5,000 API calls per day
  • Enterprise Plan: 10,000 API calls per day

However, this information should be verified with Wealthbox directly, as it's from a third-party source.

Key Points to Consider

  • The API uses standard HTTP response codes to indicate request status.

  • Authentication is required for every request, using either an API access token or OAuth 2.0.

  • Access tokens expire after two hours, while refresh tokens last for 90 days.

  • Developers should design their applications to work within these rate limits.

Best Practices

  • Use OAuth authentication for better security and user-specific access.

  • Implement proper error handling for rate limit errors (429 status code).

  • Consider using refresh tokens to maintain long-term access without requiring user re-authentication.

  • If higher rate limits are needed, contact Wealthbox support.

It's important to note that while these details provide a general overview, the most up-to-date and accurate information should always be obtained directly from Wealthbox's official API documentation or by contacting their support team.

Latest API Version

Based on the search results provided, I could not find a specific version number for the most recent Wealthbox CRM API. However, I can provide some key information about the Wealthbox API:

Key Points:

  1. The Wealthbox API is a REST-based API that allows developers to interact with Wealthbox CRM data.

  2. The API endpoint is https://api.crmworkspace.com.

  3. The API uses OAuth 2.0 for authentication, allowing for secure access to user data.

  4. It provides read/write access to various Wealthbox CRM features, including contacts, tasks, events, notes, opportunities, and projects.

API Capabilities:

The Wealthbox API allows developers to:

  • Retrieve, create, and edit contacts, tasks, events, notes, opportunities, and projects
  • Retrieve CRM activity stream data
  • Trigger CRM workflow notifications
  • Run CRM reports and fetch results
  • Retrieve various CRM-related data such as opportunity stages, contact types, and custom fields

Best Practices:

  1. Use the provided documentation: Wealthbox emphasizes a "documentation first" approach, ensuring that the API documentation is always up-to-date and tested against the live API.

  2. Implement proper authentication: Use OAuth 2.0 for secure access to user data.

  3. Handle errors appropriately: The API uses standard HTTP response codes to indicate the status of requests.

  4. Be mindful of rate limits: While not explicitly mentioned in the search results, it's good practice to be aware of any potential rate limits when working with APIs.

In conclusion, while the exact version number is not provided, the Wealthbox API appears to be actively maintained and provides comprehensive access to Wealthbox CRM data. For the most up-to-date information and specific version details, it would be best to consult the official Wealthbox API documentation or contact their support team directly.

How to get a Wealthbox CRM developer account and API Keys?

To get a developer account for Wealthbox CRM to create an API integration, you need to follow these steps:

Request API Access

  1. Email [email protected] with your request for API access and details about your application.

  2. Provide information about your intended use of the API and your application to Wealthbox.

Register Your Application

Once approved, you'll need to register your application with Wealthbox to receive the necessary credentials:

  1. Wealthbox will issue you a client ID and client secret to uniquely identify your application.

  2. The client ID is public and will be exposed when the authorization flow begins in the user's browser.

  3. The client secret must be kept secure and known only to you and Wealthbox. Store it safely.

Implement OAuth 2.0 Authentication

Wealthbox uses OAuth 2.0 for API authentication. Here's a basic overview of the process:

  1. Direct users to the Wealthbox authorization URL with your client ID and other required parameters.

  2. After user authorization, you'll receive an authorization code.

  3. Exchange this code for an access token by making a POST request to Wealthbox's token endpoint.

  4. Use the received access token to make API requests on behalf of the user.

Key Points to Consider

  • Wealthbox supports both authorization code grants and refresh token grants.
  • Authorization is scoped to individual users, not organizations.
  • Available scopes for API access are "login" and "data".
  • The API endpoint for making requests is https://api.crmworkspace.com.

Best Practices

  • Securely store your client secret. If compromised, contact Wealthbox immediately for a replacement.
  • Implement proper error handling and token refresh mechanisms in your integration.
  • Familiarize yourself with Wealthbox's API documentation and adhere to their usage guidelines.

By following these steps and best practices, you can set up a developer account and create an API integration with Wealthbox CRM. Remember to review their full API documentation for detailed information on available endpoints and data structures.

What can you do with the Wealthbox CRM API?

Based on the information provided in the search results, here's a list of data models you can interact with using the Wealthbox CRM API, along with what is possible for each:

Contacts

  • Retrieve all contacts
  • Create a new contact
  • Fetch an existing contact
  • Update an existing contact
  • Delete an existing contact

Tasks

  • Retrieve all tasks
  • Create a new task and assign it to a user or team
  • Fetch an existing task
  • Update an existing task and assign it to a user or team
  • Delete a task

Events

  • Retrieve all events
  • Create a new event
  • Fetch an existing event
  • Update an existing event
  • Delete an event

Notes

  • Retrieve all notes
  • Create a new note
  • Fetch an existing note
  • Update an existing note

Opportunities

  • Retrieve all opportunities
  • Create a new opportunity
  • Fetch an existing opportunity
  • Update an existing opportunity
  • Delete an opportunity

Projects

  • Retrieve all projects
  • Create a new project
  • Fetch an existing project
  • Update an existing project
  • Delete a project

Workflows

  • Retrieve all workflows
  • Create a new workflow
  • Fetch an existing workflow
  • Delete a workflow

Additional Data Models

  • Retrieve CRM activity stream data
  • Trigger CRM workflow notifications
  • Run CRM reports and fetch results
  • Retrieve opportunity stages, contact types, contact sources, file categories, custom fields, investment objectives, and financial account types

Other Interactable Data

  • Contact Roles
  • Custom Fields
  • Tags
  • Customizable Categories
  • Comments
  • Household Members
  • User Groups
  • Teams

The Wealthbox API provides comprehensive access to these data models, allowing developers to create, read, update, and delete (CRUD) operations on most of them. This enables seamless integration with other systems and the ability to automate various CRM-related tasks.