Ignorar e ir ao conteúdo principal

Use the CRM extensions API to create custom CRM cards that can display data on CRM records.

You want to display information from Jira tickets on relevant contact records so that customer support reps can access them directly while working with those customers.

Guia relacionado:

Extensions overview

GET

/extensions/sales-objects/v1/object-types/:object-type-id

View the details for an existing object type. See creating an object type or the overview page for details on the returned fields.

Requisitos
Escopos
  1. integration-sync
Métodos de autenticação

Aplicativos privados

OAuth

Parâmetros
object-type-id*

Param. de consulta

The id of the object type you want to get.

hapikey*

Param. de consulta

Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.

Resposta

Mostrar mais

POST

/extensions/sales-objects/v1/object-types

Create a new CRM Extensions object type.

Requisitos
Escopos
  1. integration-sync
Métodos de autenticação

Aplicativos privados

OAuth

Parâmetros
hapikey*

Param. de consulta

Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.

applicationId*

Parâm. de corpo

The ID of the HubSpot application that will own this object type.

baseUris*

Parâm. de corpo

A list of URIs. When you define actions, the URIs for these actions must be under one of these URIs.

dataFetchUri*

Parâm. de corpo

The URI the CRM will call to fetch Sales Objects for the specified associatedHubSpotObjectTypes.

title*

Parâm. de corpo

The title of this object. This will be displayed as the title of the CRM sidebar card.

propertyDefinitions*

Parâm. de corpo

The common properties that these objects will have, in the order they should appear on the sidebar card. See Property Types for more info.

associatedHubSpotObjectTypes*

Parâm. de corpo

A set of CONTACT, COMPANY, DEAL, or TICKET. This determines where on the CRM this Object Type will appear -- contact, company, deal, or ticket details pages.

associatedHubSpotObjectTypeProperties*

Parâm. de corpo

HubSpot properties to send in the data fetch request, by CRM object type.

Resposta

Mostrar mais

PUT

/extensions/sales-objects/v1/object-types/:object-type-id

Update the details for an existing object type. See creating an object type or the overview page for details on the required fields.

Note: The entire JSON structure for the object type must be provided in the request body. Anything not proviuded in the request body will be removed from the object type.

Requisitos
Escopos
  1. integration-sync
Métodos de autenticação

Aplicativos privados

OAuth

Parâmetros
object-type-id*

Parâm. de caminho

The id of the object type you want to update.

hapikey*

Param. de consulta

Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.

Object JSON*

Parâm. de corpo

The JSON representing the details for the object type.See creating an object type or the overview page for details on the required fields.

Resposta

Mostrar mais

DELETE

/extensions/sales-objects/v1/object-types/:object-type-id

Delete an existing object type.

Requisitos
Escopos
  1. integration-sync
Métodos de autenticação

Aplicativos privados

OAuth

Parâmetros
object-type-id*

Parâm. de caminho

The id of the object type you want to delete.

hapikey*

Param. de consulta

Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.

Resposta

Mostrar mais