curl --request GET \
--url https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response{
"allItemsLinkUrl": "https://example.com/all-items-link-url",
"cardLabel": "Tickets",
"responseVersion": "v3",
"sections": [
{
"actions": [
{
"httpMethod": "POST",
"label": "action-hook-label",
"propertyNamesIncluded": [
"email",
"firstName"
],
"type": "ACTION_HOOK",
"url": "https://example.com/action-hook-frame"
},
{
"confirmation": {
"cancelButtonLabel": "Cancel",
"confirmButtonLabel": "Continue",
"prompt": "action-confirmation-body-prompt"
},
"httpMethod": "POST",
"label": "confirmation-hook-label",
"type": "ACTION_HOOK",
"url": "https://example.com/confirmation-action-hook"
},
{
"height": 480,
"label": "iframe-action-label",
"propertyNamesIncluded": [
"property1",
"property2",
"property3"
],
"type": "IFRAME",
"url": "https://example.com/iframe-action-label",
"width": 640
}
],
"id": "123",
"linkUrl": "http://example.com/1",
"title": "API-22: APIs working too fast",
"tokens": [
{
"dataType": "DATE",
"label": "test_label",
"name": "created",
"value": "2016-08-04"
}
]
}
],
"topLevelActions": {
"primary": {
"height": 480,
"label": "test_label_primary",
"type": "IFRAME",
"url": "https://example.com/primary-iframe",
"width": 640
},
"secondary": [
{
"height": 480,
"label": "test_label_secondary",
"type": "IFRAME",
"url": "https://example.com/secondary-iframe",
"width": 640
}
],
"settings": {
"height": 480,
"label": "Edit",
"propertyNamesIncluded": [
"some_crm_property"
],
"type": "IFRAME",
"url": "https://example.com/iframe-contents",
"width": 640
}
},
"totalCount": 1
}Renvoie un exemple de réponse de détail de carte. Il s’agit de la charge utile avec les détails affichés pour une carte qui sera montrée à un utilisateur. Une application doit envoyer cela en réponse à la demande de récupération des données.
curl --request GET \
--url https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response{
"allItemsLinkUrl": "https://example.com/all-items-link-url",
"cardLabel": "Tickets",
"responseVersion": "v3",
"sections": [
{
"actions": [
{
"httpMethod": "POST",
"label": "action-hook-label",
"propertyNamesIncluded": [
"email",
"firstName"
],
"type": "ACTION_HOOK",
"url": "https://example.com/action-hook-frame"
},
{
"confirmation": {
"cancelButtonLabel": "Cancel",
"confirmButtonLabel": "Continue",
"prompt": "action-confirmation-body-prompt"
},
"httpMethod": "POST",
"label": "confirmation-hook-label",
"type": "ACTION_HOOK",
"url": "https://example.com/confirmation-action-hook"
},
{
"height": 480,
"label": "iframe-action-label",
"propertyNamesIncluded": [
"property1",
"property2",
"property3"
],
"type": "IFRAME",
"url": "https://example.com/iframe-action-label",
"width": 640
}
],
"id": "123",
"linkUrl": "http://example.com/1",
"title": "API-22: APIs working too fast",
"tokens": [
{
"dataType": "DATE",
"label": "test_label",
"name": "created",
"value": "2016-08-04"
}
]
}
],
"topLevelActions": {
"primary": {
"height": 480,
"label": "test_label_primary",
"type": "IFRAME",
"url": "https://example.com/primary-iframe",
"width": 640
},
"secondary": [
{
"height": 480,
"label": "test_label_secondary",
"type": "IFRAME",
"url": "https://example.com/secondary-iframe",
"width": 640
}
],
"settings": {
"height": 480,
"label": "Edit",
"propertyNamesIncluded": [
"some_crm_property"
],
"type": "IFRAME",
"url": "https://example.com/iframe-contents",
"width": 640
}
},
"totalCount": 1
}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.
Le nombre total de propriétés de carte qui seront envoyées dans cette réponse.
URL vers une page que l'intégrateur a créée et qui affiche tous les détails de cette carte. Cette URL sera affichée aux utilisateurs sous un lien « Voir plus [x] » s'il y a plus de cinq éléments dans votre réponse, où « [x] » est la valeur de « itemLabel ».
Le libellé à utiliser pour le lien « allItemsLinkUrl » (par exemple, « Voir plus de tickets »). Si non fourni, cela revient au titre de la carte.
La version numérique de la réponse.
v1, v3 Une liste de jusqu'à cinq sous-catégories de cartes valides.
Afficher attributs enfants
Afficher attributs enfants