Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Use CRM data components sample

This React Project demonstrates the usage of HubSpot CRM Components through UIE. The project includes 2 extensions:

  1. Association Table displaying important deals associated with the current user (demonstrates pre-filters, quick filters, and property projections)
  2. Stage tracker with high level properties, and property list filtered by pipeline

These extensions demonstrate a number of interactions including:

  • Using HubSpot's CRM Data Components
  • Using new styling/layout components available through UIE
  • Making API calls to the HubSpot API using serverless functions
  • Fetching properties for the current object

Example Image of the Association Table Example Image of Stage Tracker

Prerequisites

  • You must have an active HubSpot account.
  • You must have the latest HubSpot CLI installed.
  • Run hs init if you haven't already done so to create a config file for your parent account.
  • Run hs auth to authenticate your account. Alternatively, select your pre-authenticated account with hs accounts use.

Quick Start

Step 1: Clone the repository

Clone this repository and navigate to the project directory:

git clone https://github.com/HubSpot/ui-extensions-examples.git
cd ui-extensions-examples/crm-data-components

Step 2: Install dependencies

Run hs project install-deps to install the dependencies for this project.

Step 3: Upload project

Run hs project upload. If you’d like to build on this project, run hs project dev to kickoff the dev process and see changes reflected locally as you build.

Step 4: View the cards

For CRM data: Stage Tracker example card. In the main menu select Sales > Deals to view deal records. Click on any of the deal objects and navigate to the custom tab to access the two sample cards. If you don’t have any deals in the account you’re using to view this sample, create a deal by the following steps:

  1. In the main menu, select Sales > Deals.
  2. Click Create deal in the top right hand corner and fill in all required fields. Click create once you’ve finished filling in your deal details.
  3. Your new deal should appear in the Deals table. Select it and navigate to the custom tab in the middle pane to access the sample cards.

For CRM data: Association Table example card.In the main menu select Contacts > Contacts to view contact records. Click on any of the contact objects and navigate to the custom tab to access the sample card. If you don’t have any contacts in the account you’re using to view this sample, create a contact by the following steps:

  1. In the main menu, select Contacts > Contacts.
  2. Click Create contact in the top right hand corner and fill in all required fields. Click create once you’ve finished filling in your contact details.
  3. Your new contact should appear in the Contacts table. Select it and navigate to the Custom tab in the middle pane to access the sample card.

If you haven't customized the tabs before follow step #4 from this guide to add the two sample cards.