topic Re: How can I use the card I created? in APIs & Integrations

How can I use the card I created?

JZhao — Mon, 18 Jan 2021 03:18:27 GMT

I read this doc https://developers.hubspot.com/docs/api/crm/extensions/custom-cards and create an app. Then created a card in the app.

After that, how can I use the card I just created?

I access to hubspos dashboard by this URL: https://app.hubspot.com/dashboard-library/8013920. And the app and card were created by a develop account. How does the develop account link the the dashboard? Or how does the app link to the dashboard? All concepts "app", "dashboard", "develop account", "card" are confusing me and I can't find doc about how to use them.

Can you please provide me some guide on this thanks?

Re: How can I use the card I created?

dennisedson — Tue, 19 Jan 2021 17:23:29 GMT

Hey @JZhao

The app lives in your developer account.

The dashboard lives in a normal portal. You would need to connect the app to the portal. Here is a doc on authentication methods for your app. We strongly advise using OAuth

Good luck with your project!

Re: How can I use the card I created?

JZhao — Thu, 21 Jan 2021 05:48:08 GMT

Hi @dennisedson ,

The doc https://developers.hubspot.com/docs/api/intro-to-auth you mentioned, doesn't really tell how to connect the app to the portal. I have three accounts in the normal portal, `prod`, `staging` and `dev`. And I created a developer account. How does the develop account link to each normal portal account?

I also read this doc https://developers.hubspot.com/docs/api/working-with-oauth

it only says how to configure auth in develop account. It doesn't mention how to connect it to portal account.

Could you let me know how to connect?

Re: How can I use the card I created?

dennisedson — Thu, 21 Jan 2021 17:21:07 GMT

Hello @JZhao

When you create the app, you will creating an auth url that will be used to authorize the app to be used in a portal (can be multiple). Once approved, there will be a redirect to a success page of your creation.

Maybe this doc will spell it out better 😀

Re: How can I use the card I created?

JZhao — Thu, 21 Jan 2021 22:56:19 GMT

Hi @dennised

thanks for your reply.

My use case is that I have a bandend service which will talk to hubspot via API to manage users, companies, tickets, etc.

I need to embed an external website into a card which can be open when users click on the card in their company.

Based on that, do I need to create an app? or extension? Do I need to use oauth at all?

Re: How can I use the card I created?

dennisedson — Thu, 21 Jan 2021 23:01:18 GMT

Hey @JZhao

You will need an app in which you will create your CRM card extension.

You will also need OAuth as stated in the docs

Scope requirements

To create custom CRM cards, your app has to request the OAuth scopes needed to modify the CRM records where your card will appear. This means you request the contacts scope to set up a card for contacts, companies, or deals, and the tickets scope to do the same for tickets.

See the OAuth documentation for more details about scopes and setting up the authorization URL for your app.

Re: How can I use the card I created?

JZhao — Fri, 22 Jan 2021 03:24:49 GMT

Is the oauth required to build a app and CRM card extension? Can I use app api key instead?

Hubspot is mainly used by my backend service no other people is going to use. I don't see any benefits to bring oauth in.

Re: How can I use the card I created?

dennisedson — Fri, 22 Jan 2021 03:26:20 GMT

For a crm card, yes

Re: How can I use the card I created?

dennisedson — Fri, 22 Jan 2021 03:28:13 GMT

@Mike_Eastwood might be able to provide some more insight!

Re: How can I use the card I created?

Mike_Eastwood — Fri, 22 Jan 2021 03:39:42 GMT

Hi @JZhao

I recommend putting in the extra effort to set up OAuth2, even if it's only you using it.

Once you authorise the App, in your Portal, you can still use the Hapikey for development.

But, for day to day use, we alays set up an OAuth connection because it's more reliable.

When testing I like to use Postman to check everything's working as planned (using both OAuth and the Hapikey).

If you go with OAuth you need to make sure you Scopes are identical and in the same order as your App (e.g. same in your code as the app because it creates a hash that won't be the same if the order is different).

Have fun

Mike

Re: How can I use the card I created?

JZhao — Fri, 22 Jan 2021 03:55:27 GMT

In oauth setup process, how can I fill in redirect url since I don't have any backend service open to the public.

Re: How can I use the card I created?

Mike_Eastwood — Fri, 22 Jan 2021 04:00:24 GMT

@JZhao oh, that's a problem – you can't return to a local server.

Usually we authorise through a public server then copy the OAuth tokens to the local server.

Once they are on the local server they work normally (with refresh tokens).

Sounds like you may need to stick to the Hapikey.

Mike

Re: How can I use the card I created?

JZhao — Fri, 22 Jan 2021 04:18:16 GMT

That's what I am thinking. But the question is how to install an app/extension via Hapikey?

Re: How can I use the card I created?

Mike_Eastwood — Fri, 22 Jan 2021 04:30:14 GMT

Sorry @JZhao – my mistake – you have to have publicly accessible URLs to use CRM Cards.

When the CRM loads it calls the URL for the CRM Extension and loads the returned JSON into the CRM.

So you will need to set up an external server and OAuth.

Mike