Detalhes da extensão
Essa API é estável, mas usa um formato antigo. Isso significa que algumas funcionalidades podem não estar disponíveis (por exemplo, chamadas de teste e integração Postman).
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 overviewGET
/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
integration-sync
Parâmetros
The id of the object type you want to get.
Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
Resposta
Example GET URL:
https://api.hubapi.com/extensions/sales-objects/v1/object-types/678?hapikey=
Example response:
{
"id": 678,
"applicationId": 12345,
"baseUris": [
"https://example.com/actions"
],
"dataFetchUri": "https://example.com/demo-tickets",
"title": "DemoTickets",
"propertyDefinitions": [
{
"name": "ticket_type",
"label": "Ticket type",
"dataType": "STRING"
},
{
"options": [
{
"type": "SUCCESS",
"label": "In Progress",
"name": "inprogress"
},
{
"type": "DEFAULT",
"label": "Resolved",
"name": "resolved"
}
],
"name": "status",
"label": "Status",
"dataType": "STATUS"
},
{
POST
/extensions/sales-objects/v1/object-types
Create a new CRM Extensions object type.
Requisitos
integration-sync
Parâmetros
Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
The ID of the HubSpot application that will own this object type.
A list of URIs. When you define actions, the URIs for these actions must be under one of these URIs.
The URI the CRM will call to fetch Sales Objects for the specified associatedHubSpotObjectTypes.
The title of this object. This will be displayed as the title of the CRM sidebar card.
The common properties that these objects will have, in the order they should appear on the sidebar card. See Property Types for more info.
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.
HubSpot properties to send in the data fetch request, by CRM object type.
Resposta
xxxxxxxxxx
Example POST URL:
https://api.hubapi.com/extensions/sales-objects/v1/object-types?hapikey=
Example POST data:
{
"applicationId": 12345,
"baseUris": [
"https://example.com/actions"
],
"dataFetchUri": "https://example.com/demo-tickets",
"title": "DemoTickets",
"propertyDefinitions": [
{
"name": "ticket_type",
"label": "Ticket type",
"dataType": "STRING"
},
{
"options": [
{
"type": "SUCCESS",
"label": "In Progress",
"name": "inprogress"
},
{
"type": "DEFAULT",
"label": "Resolved",
"name": "resolved"
}
],
"name": "status",
"label": "Status",
"dataType": "STATUS"
},
{
"name": "priority",
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
integration-sync
Parâmetros
The id of the object type you want to update.
Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
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
xxxxxxxxxx
Example PUT URL:
https://api.hubapi.com/extensions/sales-objects/v1/object-types/678?hapikey=
Example PUT data:
{
"id": 678,
"applicationId": 12345,
"baseUris": [
"https://example.com/actions"
],
"dataFetchUri": "https://example.com/demo-tickets",
"title": "DemoTickets",
"propertyDefinitions": [
{
"name": "ticket_type",
"label": "Ticket type",
"dataType": "STRING"
},
{
"name": "priority_updated",
"label": "Priority (Updated)",
"dataType": "STRING"
},
{
"name": "project",
"label": "Project",
"dataType": "STRING"
},
{
"name": "new_property",
"label": "New Property",
"dataType": "STRING"
}
],
"associatedHubSpotObjectTypes": [
"COMPANY"
DELETE
/extensions/sales-objects/v1/object-types/:object-type-id
Delete an existing object type.
Requisitos
integration-sync
Parâmetros
The id of the object type you want to delete.
Your Developer HAPIkey. This must be a Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
Resposta
xxxxxxxxxx
Example DELETE URL:
https://api.hubapi.com/extensions/sales-objects/v1/object-types/678?hapikey=
Returns a 204 No Content response on success.