What is an Open API?
An Open API (Application Programming Interface) is a standardized set of rules and protocols that allows different software applications to communicate and work together. It’s publicly available, meaning developers can use it to connect their apps to other systems or services. This enables the automation of tasks and the sharing of data between different platforms.
What's special about SmartMoving's Open API?
SmartMoving's Open API, available only to Growth Plan users, allows businesses to seamlessly integrate their favorite apps and tools, keeping data synchronized across systems. It enables the automatic import, visualization, and reporting of SmartMoving data, streamlining operations and reducing manual tasks. With custom API endpoints and webhooks, your moving and storage business can create leads, connect phone systems, and automate notifications, ultimately enhancing efficiency and supporting business growth.
Keep reading for a closer look at what our Open API will do for your business.
➡️ Create custom reporting dashboards.
SmartMoving’s Open API offers the ability to connect your data to data visualization tools (e.g. Tableau, Power BI, etc.).
This will allow you to do the following:
Import the above mentioned data into the data visualization tool of your choice to get a complete picture of your business' health.
Create custom dashboards in a data visualization tool to give your sales and accounting departments instant access to key metrics through visuals, making it easy to see their performance at a glance.
➡️ Create follow-up tasks in any Project Management solution.
With SmartMoving’s Open API, your company can leverage webhooks to send data to any source that supports them to automatically send new leads and booked moves into a project management tool (e.g. Monday, Asana, etc.) to leverage their workflows. The API sends values for leads, follow-ups, estimates, payments, documents, customers and jobs. It also allows you to update data for jobs, payments and customers.
This will allow you to do the following:
Create workflows, assign leads and tasks for lead follow-up.
Assign booked moves to specific employees and create tasks to prepare for a move based on data like the size and location of the move. This would allow your employees to know which trucks to clean, which tools to include, how many pads, boxes, tape and bubble wrap to stock.
➡️ Link SmartMoving to your phone system for better, faster customer service.
With SmartMoving’s Open API, when a customer calls who is already in SmartMoving as a lead, opportunity, or booked job, your phone system (e.g. RingCentral) can match the caller's phone number with their SmartMoving record and automatically route the call to the appropriate person.
➡️ Track important notifications to messaging apps.
SmartMoving’s Open API allows your company to send alert notifications for new leads directly to a messaging platform of your choice (e.g. Slack, Teams, etc.) for proper follow-up. This way, the right people are notified when a new lead comes in, enabling them to quickly collaborate to create accurate estimates that convert leads.
➡️ Import a lead from e-mail (or any source) directly into SmartMoving.
With SmartMoving’s Open API, you can integrate with any third-party source to automatically add new leads directly into SmartMoving. Our API populates the values for leads so your team doesn't have to manually type them into SmartMoving.
Getting Started with SmartMoving API
To start using our Open API, go to Settings > Integrations > SmartMoving API and toggle the API on.
After doing so, you’ll receive everything you need to authenticate your API requests:
API Key
Client ID
Primary Client Secret
Secondary Client Secret
Learn how to use them on the following section.
Authentication
⚠️ We have removed the require for OAuth+token authentication from our API, simplifying implementation and maintenance. Please update your API authentication by November 19, 2024, as the OAuth+token method will be deprecated on this date.
All requests sent to the SmartMoving API must be authorized with your API Key.
Add your API Key in the x-api-key header, like so:
curl -X GET https://<smartmoving-external-api>/api/customers/Page=1&PageSize=10
-H 'Content-Type: application/json'
-H 'x-api-key: <API key>'
API User Reference
API Developer Portal
To view our SmartMoving API documentation and learn about all the endpoints we have available, please visit our publicly accessible portal to see all of our available endpoints.
Webhooks
If you are a Premium API user, you can configure one or more webhooks to send data from SmartMoving right after certain events occur. To configure them, go to: Settings > Integrations > SmartMoving API > Webhooks > Add New Webhook. Then, add your callback URL and complete the wizard.
Monitor your usage
Monitor your request amount, ensure you are staying within your quota, and access the documentation.
API Help Video: Setting Up and Configuring SmartMoving's API