In general, the following Out-of-the-Box integrations are supported within Essential and/or Plus subscriptions and do not require customization beyond the scope of a standard implementation.

IdeaRoom's most commonly utilized Out-of-the-Box integrations include:

1) HubSpot

2) Shed Suite

3) RTO National's DMS 

4) CAL

5) ZipTax

6) Google Analytics, Facebook Pixel & other Ad Tracking Parameters

Zapier is included in all subscription plans. Zapier is an online automation tool that facilitates integration between web applications without coding. For example, a client may utilize Zapier to send quotes to an unsupported CRM system. 

Clients can use Zapier to set up endpoints that can request and receive data from IdeaRoom configurators. To utilize this option, clients must sign up with Zapier directly. 

Technical documentation for setting up an integration via Zapier can be found at this link.

In short, Design Mode enables Clients to utilize IdeaRoom as a "front end" designer. The most common use case is that a Client wishes to embed IdeaRoom within an inventory management system, utilizing the designer to create orders or new inventory buildings.

Developer documentation for Design Mode can be found here. A working example of a Design Mode implementation can be found at this link.

Background

A webhook is a scheme for connecting disparate internet software services together for the purpose of integration and data exchange. A webhook automatically pushes data from one software system to another when an event occurs. In IdeaRoom, the webook pushes data to a target system when a user initiates an action in IdeaRoom like saving, quoting, or ordering a configured product design.

Successful use of a webhook to integrate typically requires a software developer to write the service that receives the data from the IdeaRoom API and pushes it into the target system API. IdeaRoom uses the webhook to support built-in integrations such as HubSpot CRM. In this instance, IdeaRoom wrote the web service that pushes IdeaRoom data into HubSpot CRM and creates a customer contact and deal record. The contact holds the customer information, and the deal record holds summary information about the configured product design.

Common webhook integration scenarios include:

• Custom Customer Relationship Management (CRM) system for managing leads and sales conversations.

• Enterprise Resource Planning (ERP) systems for managing orders or generating bill-of-materials.

• Inventory management systems for creating and managing inventory buildings.

• Financing or RTO systems for generating and managing financing contracts.

Events

The webhook can be set up to trigger on any of the following events:

• Created: User submits a new product configuration via save, quote, or checkout actions.

• Updated: User opens an existing design from a link and re-submits to the same email address.

• Visited: A user loaded a previously saved design using the design link.

• Checkout Opened: User presses the checkout button and starts the checkout process.

• Payment Prepared: User submits the first checkout step that includes payment method selection.

Data

The data IdeaRoom publishes through the webhook includes:

• Customer Contact

• Order Summary & Line Items

• Product Design Details

• 3D & Floor Plan Images

JSON Examples of Webhook Payload

IdeaRoom for Sheds

IdeaRoom for Carports

The REST API is an on-demand GET version of the webhook. It is very similar, if not identical to the webhook payload (documentation here).

A unique hash identifier can be utilized to call each building save, design or order, and the REST API will return the same payload as the webhook sends when the original event occurred. In some instances, a Client may choose to call IdeaRoom data on demand rather than pulling them in as the submissions occur through the webhook.