Enabling Calling Extension SDK & Required Scopes

Hi Hubspot Team,

We are currently building a custom CTI connector using the Calling Extension SDK. We have our connected app set up, but we are looking for clarification on the initialization process.

We identified this endpoint to configure the application settings: PATCH /crm/v3/extensions/calling/{app_id}/settings

Is hitting this endpoint the standard/official method to enable the Calling SDK for our app (both for dev and live), or is there a different workflow we should follow to “activate” the calling features?

Additionally, could you confirm the specific scopes required? We want to ensure we have the correct permissions enabled in our developer account.

Hi @VineetArora,

You don’t really “activate” Calling Extensions separately.

HubSpot treats your calling provider as available once you’ve created your calling settings for the app, and when you flip isReady to true it’s considered ready for users to select in HubSpot.

For scopes, HubSpot calls out that you need:

  • contacts
  • timeline

Those give you access to contacts and let HubSpot create and update the call engagement on the CRM timeline.

It looks like you’re already familiar, but here are the dev docs on the topic.

Josh

Hi @VineetArora

Thanks for the post!
I want to share with you some helpful resources:

Als,o a Community Thread with more context:
https://community.hubspot.com/t5/APIs-Integrations/Access-to-Calling-in-Developer-Account/m-p/1068490#M78160

Hey @alyssamwilie @h-recker @TTolley, any ideas you would like to add?

Thanks!
Victor

Hey @VineetArora

Josh covered this well. Just wanted to add a couple things from experience. The PATCH endpoint you found is indeed the right one, and once you set isReady to true your app shows up as a calling option in HubSpot. There’s no separate activation step or approval gate, it just becomes available. One thing that tripped us up when we were working with HubSpot’s APIs is that the dev portal and the live environment behave slightly differently, so make sure you test the full flow in a developer test account before pushing settings to your production app ID.

On scopes, contacts and timeline are the minimum to get calls logging properly on the CRM timeline. But if your connector needs to do things like look up associated companies or deals during a call (for screen pops or context panels), you’ll want to request those additional scopes early rather than having to re authorize users later. Worth thinking about what your connector will need six months from now, not just what it needs today.

Good luck with the build!