curl --request GET \
--url https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response{
"totalCount": 123,
"allItemsLinkUrl": "<string>",
"cardLabel": "<string>",
"responseVersion": "v1",
"sections": [
{
"actions": [
{
"httpMethod": "CONNECT",
"propertyNamesIncluded": [
"<string>"
],
"type": "ACTION_HOOK",
"url": "<string>",
"confirmation": {
"cancelButtonLabel": "<string>",
"confirmButtonLabel": "<string>",
"prompt": "<string>"
},
"label": "<string>"
}
],
"id": "<string>",
"title": "<string>",
"tokens": [
{
"value": "<string>",
"dataType": "BOOLEAN",
"label": "<string>",
"name": "<string>"
}
],
"linkUrl": "<string>"
}
],
"topLevelActions": {
"secondary": [
{
"httpMethod": "CONNECT",
"propertyNamesIncluded": [
"<string>"
],
"type": "ACTION_HOOK",
"url": "<string>",
"confirmation": {
"cancelButtonLabel": "<string>",
"confirmButtonLabel": "<string>",
"prompt": "<string>"
},
"label": "<string>"
}
],
"primary": {
"httpMethod": "CONNECT",
"propertyNamesIncluded": [
"<string>"
],
"type": "ACTION_HOOK",
"url": "<string>",
"confirmation": {
"cancelButtonLabel": "<string>",
"confirmButtonLabel": "<string>",
"prompt": "<string>"
},
"label": "<string>"
},
"settings": {
"height": 123,
"propertyNamesIncluded": [
"<string>"
],
"type": "IFRAME",
"url": "<string>",
"width": 123,
"label": "<string>"
}
}
}Obter amostra de resposta de detalhes do cartão
Retorna um exemplo de resposta de detalhes do cartão. Esta é a carga útil com detalhes exibidos para um cartão que será mostrado a um usuário. Um aplicativo deve enviar isso em resposta à solicitação de busca de dados.
curl --request GET \
--url https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response{
"totalCount": 123,
"allItemsLinkUrl": "<string>",
"cardLabel": "<string>",
"responseVersion": "v1",
"sections": [
{
"actions": [
{
"httpMethod": "CONNECT",
"propertyNamesIncluded": [
"<string>"
],
"type": "ACTION_HOOK",
"url": "<string>",
"confirmation": {
"cancelButtonLabel": "<string>",
"confirmButtonLabel": "<string>",
"prompt": "<string>"
},
"label": "<string>"
}
],
"id": "<string>",
"title": "<string>",
"tokens": [
{
"value": "<string>",
"dataType": "BOOLEAN",
"label": "<string>",
"name": "<string>"
}
],
"linkUrl": "<string>"
}
],
"topLevelActions": {
"secondary": [
{
"httpMethod": "CONNECT",
"propertyNamesIncluded": [
"<string>"
],
"type": "ACTION_HOOK",
"url": "<string>",
"confirmation": {
"cancelButtonLabel": "<string>",
"confirmButtonLabel": "<string>",
"prompt": "<string>"
},
"label": "<string>"
}
],
"primary": {
"httpMethod": "CONNECT",
"propertyNamesIncluded": [
"<string>"
],
"type": "ACTION_HOOK",
"url": "<string>",
"confirmation": {
"cancelButtonLabel": "<string>",
"confirmButtonLabel": "<string>",
"prompt": "<string>"
},
"label": "<string>"
},
"settings": {
"height": 123,
"propertyNamesIncluded": [
"<string>"
],
"type": "IFRAME",
"url": "<string>",
"width": 123,
"label": "<string>"
}
}
}
Marketing HubGrátis
Sales HubGrátis
Service HubGrátis
Content HubGrátisResponse
successful operation
The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.
O número total de cartões enviados nesta resposta.
URL de uma página criada pelo integrador que exibe todos os detalhes dos cartões de objeto. Esse URL será exibido aos usuários no título do cartão.
O rótulo a ser usado para o link "allItemsLinkUrl" (por exemplo, "Ver mais tickets") e o título do cartão.
A versão numérica da resposta.
v1, v3 Uma lista de até cinco subcategorias de cartões válidas.
Mostrar atributos filhos
Mostrar atributos filhos
Uma lista de ações associadas ao cartão, que pode incluir hooks de ação, hooks de ação de confirmação ou iframes.
- ACTION_HOOK
- IFRAME
Mostrar atributos filhos
Mostrar atributos filhos
O método HTTP a ser usado ao fazer a chamada, que pode ser definido como GET, POST, PUT, DELETE ou PATCH. Se usar GET ou DELETE
CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE Uma lista de nomes de propriedades que serão incluídas na ação. Consulte a documentação para obter mais informações.
Especifica o tipo de ação, que é "ACTION_HOOK" para hooks de ação.
ACTION_HOOK O endpoint do URL que será chamado quando a ação for acionada.
Mostrar atributos filhos
Mostrar atributos filhos
O rótulo do botão que cancela a ação.
O rótulo do botão que confirma a ação.
A mensagem exibida ao usuário para confirmar a ação.
O rótulo do botão que aciona a ação, tal como será exibido aos usuários.
O identificador exclusivo do cartão.
O título do cartão do objeto, exibido para os usuários.
Um conjunto de tokens que representam propriedades específicas relacionadas ao cartão.
Mostrar atributos filhos
Mostrar atributos filhos
O valor da propriedade
O tipo da propriedade. Pode ser: MOEDA, DATA, DATA E HORA, E-MAIL, LINK, NUMÉRICO, STATUS.
BOOLEAN, CURRENCY, DATE, DATETIME, EMAIL, LINK, NUMERIC, STATUS, STRING O rótulo da propriedade, tal como será exibido aos usuários
O nome da propriedade
Um URL usado no título do cartão
Mostrar atributos filhos
Mostrar atributos filhos
Especifica uma lista de ações secundárias para um cartão, cada uma das quais pode ser um hook de ação ou um iframe.
- ACTION_HOOK
- IFRAME
Mostrar atributos filhos
Mostrar atributos filhos
O método HTTP a ser usado ao fazer a chamada, que pode ser definido como GET, POST, PUT, DELETE ou PATCH. Se usar GET ou DELETE
CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE Uma lista de nomes de propriedades que serão incluídas na ação. Consulte a documentação para obter mais informações.
Especifica o tipo de ação, que é "ACTION_HOOK" para hooks de ação.
ACTION_HOOK O endpoint do URL que será chamado quando a ação for acionada.
Mostrar atributos filhos
Mostrar atributos filhos
O rótulo do botão que cancela a ação.
O rótulo do botão que confirma a ação.
A mensagem exibida ao usuário para confirmar a ação.
O rótulo do botão que aciona a ação, tal como será exibido aos usuários.
Define a ação principal de um cartão, que pode ser um hook de ação ou um iframe.
- ACTION_HOOK
- IFRAME
Mostrar atributos filhos
Mostrar atributos filhos
O método HTTP a ser usado ao fazer a chamada, que pode ser definido como GET, POST, PUT, DELETE ou PATCH. Se usar GET ou DELETE
CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE Uma lista de nomes de propriedades que serão incluídas na ação. Consulte a documentação para obter mais informações.
Especifica o tipo de ação, que é "ACTION_HOOK" para hooks de ação.
ACTION_HOOK O endpoint do URL que será chamado quando a ação for acionada.
Mostrar atributos filhos
Mostrar atributos filhos
O rótulo do botão que cancela a ação.
O rótulo do botão que confirma a ação.
A mensagem exibida ao usuário para confirmar a ação.
O rótulo do botão que aciona a ação, tal como será exibido aos usuários.
Mostrar atributos filhos
Mostrar atributos filhos
A altura do iframe em pixels.
Uma lista de nomes de propriedades que serão incluídos no URL do iframe.
Especifica o tipo de ação, que é "IFRAME" para ações de iframe.
IFRAME O endpoint do URL que será carregado no iframe quando acionado.
A largura do iframe em pixels.
O rótulo do botão que abre o iframe, tal como será exibido aos usuários.