Hubspot - sgml/signature GitHub Wiki

OpenAPI Hubspot

OAuth

Certifications

Webhooks

Error Codes

  • urllib3.exceptions.MaxRetryError
  • urllib3.exceptions.NewConnectionError
  • socket.gaierror: [Errno -2] Name or service not known

Properties

  • 'hs_object_source': 'IMPORT'

Imports

Duplicates

Custom Objects

Custom Search API

HubDB CMS API

Hubspot Markup Language: HubL/JinJava

Hubspot App Marketplace

Hubspot Rate Limits and API Request Monitoring

Blogs

Idioms

IDS

  • IDs go by the name vid, id, and hs_object_id` in the legacy API, modern contacts API, and modern properties API respectively

Legacy Contacts API

  • set both the formSubmissionMode=none and the showListMemberships=false URL params to minimize the signal/noise ratio in the API response
  • set the propertyMode=value_only URL param to only return the current property value; unset it to return the history of the property over time

V3 Search API

  • The token search filters only accept alphanumeric values, which is different from the Hubspot GUI, which accepts all characters

Custom Object Creation to deserialize JSON

Definition

from hubspot import HubSpot
from hubspot.crm.objects import SimplePublicObjectInput
from hubspot.crm.schemas import ObjectTypeDefinition, ObjectTypePropertyCreate

# Initialize the HubSpot client
client = HubSpot(api_key='your_hubspot_api_key')

# Define the custom object schema
object_type = ObjectTypeDefinition(
    name='foo',
    labels={'singular': 'Foo', 'plural': 'Foos'},
    primaryDisplayProperty='bar'
)

# Define the property for the custom object
property_definition = ObjectTypePropertyCreate(
    name='bar',
    label='Bar',
    type='string',
    fieldType='text'
)

# Create the custom object schema
custom_object_response = client.crm.schemas.core_api.create(object_type)
property_response = client.crm.schemas.properties_api.create(
    custom_object_response.object_type_id, property_definition
)

print(f"Custom Object Created: {custom_object_response}")
print(f"Property Created: {property_response}")

Instantiation

import json

# Example JSON data
json_data = '{"foo": [{"bar":"baz"}]}'
data = json.loads(json_data)

# Create custom object records
for item in data['foo']:
    custom_object = SimplePublicObjectInput(properties={
        'bar': item['bar']
    })
    record_response = client.crm.objects.basic_api.create(
        object_type=custom_object_response.object_type_id, simple_public_object_input=custom_object
    )
    print(f"Custom Object Record Created: {record_response}")