Please note: learn how to ungate your account for this beta. By using these instructions you agree to adhere to HubSpot's Developer Terms & HubSpot's Developer Beta Terms.
Developers using the Calling SDKcan now enable inbound calling within HubSpot. When a user receives and answers a call through your app in HubSpot, they can access call records directly in HubSpot, eliminating the need to switch back to the calling app. Calls are automatically logged in the Call Index Page where users can take real-time notes and review the call after it ends.
For npm, run:
- Via the
userAvailable
event:
- Via the
userUnavailable
event:
callAnswered
and callCompleted
, in the same way it is done for outgoing calls.- If you’ve set
createEngagement
to true, you can subscribe toonCreateEngagementSucceeded
andonCreateEngagementFailed
. It is recommended you do this so that you can enable your calling app to support custom objects. This will allow future integration into other areas of HubSpot.
- You will be able to subscribe to
onCallerIdMatchSucceeded
andonCalledIdMatchFailed
. This will enable you to receive contact matching data for the incoming call that previously had to be obtained via the Search API, and will solve its rate limitations.
Once you receive the caller ID matches, you can send HubSpot a message to navigate to a contact or company record page.
Once the call engagement is created, HubSpot will redirect to the contact page specified in the navigateToRecord
payload and will sync with the SDK in the onReady
event. You'll need to re-initialize the SDK using the engagement ID and show an incoming call within the iframe.
Before logging in to your calling app, you'll need to select the provider from your call settings:
- In your HubSpot account, click the settings icon in the main navigation bar.
- In the left sidebar menu, click General. Then, click the Calling tab at the top.
- Click the Make and receive calls through dropdown menu, then select your calling app.
Once the preferred provider is selected, incoming calls will only be received through the selected provider. HubSpot will not support receiving incoming calls from multiple providers in this version.
If you wish to change the provider for receiving calls, you'll have to go back to your call settings to make the change.
If you've not already set up an integration with any of the calling apps, click here to learn more.
- Log in to your calling app through the call widget in HubSpot. The call widget can be accessed on the main navigation bar.
- Set availability to e HubSpot to start receiving calls.
- Answer inbound calls from the call remote.
Once the call is completed, the inbound call gets logged in the Call Index page. Missed calls will also get logged here.
supportsInboundCalling
is set to false by default, HubSpot displays a banner under each user's preferences dropdown.
Once you have set your app settings using the calling settings endpoint, use the PATCH endpoint to change supportsInboundCalling
to true. This will remove the banner, and lets HubSpot users know your calling app has completed all the steps necessary to receive inbound calls.
Once the above steps are complete, you can continue to extend the functionality of your calling app in HubSpot by setting up third-party calling in help desk (BETA).
Thank you for your feedback, it means a lot to us.