This is a project containing a public app, so developers can get up and running on HubSpot Developer Projects. For HubSpotters, your developer account will need to be ungated to Developers:ProjectPublicAppsLaunch and crm-development-beta. For webhooks, your developer account will need to be ungated to Developers:ArbitraryCrmObjectWebhooks.
NOTE: You need to be a super-admin in the developer account, where you will be uploading your app.
-
Run
hs project upload --account=<dev-acct-id>
to build and deploy the project to your developer account. -
Retrieve the install URL located in your app's auth tab.
-
Use that install URL to install the app in a developer test account of your choice.
-
Once the app is installed in the developer test portal, navigate to the related object's record customization page. For example, if your UIE extension card will appear on Contacts record pages, navigate to the Contacts record customization page.
-
Scroll down to Data Management, expand the Objects navigation item, and select the appropriate object.
-
Select the Record Customization tab, and choose the specified layout.
-
You can either update the default view or create a team view. Then add the UI Extension card to it.
-
For webhooks: Navigate to the
webhooks.json
config file and update thetargetUrl
setting to a url that you want the webhooks to get sent to -
Once the project is built and deployed with a webhook configuration, navigate to the objects that you have subscribed to in the CRM. For example, in this project only webhook subscriptions on the contact object were created, so navigate to the contacts tab in the CRM.
-
Verify that the webhook subscriptions work by creating/updating/deleting a contact and confirm that your specified webhook URL received the event
Public app UI extensions currently only render for enterprise portals (non enterprise portals are a work in progress)