HubSpot Integration — ModuleX AI

Overview

Add HubSpot to any ModuleX agent or workflow. HubSpot CRM integration via the synchronous hubspot-api-client SDK. 26 actions across contacts, companies, deals, tickets, plus engagement (note/task/meeting) and property management.

Categories: CRM · Sales · Marketing · Auth: OAuth2, Private App Access Token · Actions: 26

Authentication

OAuth2
Private App Access Token

OAuth2 Authentication

Connect using HubSpot OAuth (recommended for most use cases)

Required Credentials

Field	Description	Required	Format
Client ID	HubSpot OAuth App Client ID	Yes	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`
Client Secret	HubSpot OAuth App Client Secret	Yes	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`

OAuth Configuration

Authorization URL: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token
Scopes: crm.objects.contacts.read, crm.objects.contacts.write, crm.objects.companies.read, crm.objects.companies.write, crm.objects.deals.read, crm.objects.deals.write, tickets, crm.schemas.contacts.read, crm.schemas.companies.read, crm.schemas.deals.read

Private App Access Token

Use a HubSpot Private App access token for authentication

Required Credentials

Field	Description	Required	Format
Access Token	HubSpot Private App access token	Yes	`pat-eu1-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`

Available Actions

get_recent_contacts — List recently modified contacts (sort: lastmodifieddate DESC)

Parameters

limit

integer

Maximum results to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "contacts": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Contacts",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRecentContactsOutput",
  "type": "object"
}

get_contact_by_id — Retrieve a contact by its HubSpot ID

Parameters

contact_id

string

required

HubSpot contact ID

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetContactByIdOutput",
  "type": "object"
}

create_contact — Create a new contact (email required)

Parameters

string

required

Contact email address

firstname

string

First name

lastname

string

Last name

phone

string

Phone number

company

string

Company

website

string

Website URL

properties

object

Additional properties to set

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateContactOutput",
  "type": "object"
}

update_contact — Update a contact's properties

Parameters

contact_id

string

required

HubSpot contact ID

properties

object

required

Properties to update

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateContactOutput",
  "type": "object"
}

search_contacts — Search contacts by query string

Parameters

query

string

required

Search query string

limit

integer

Maximum results to return (Default: 10)

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "contacts": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Contacts",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchContactsOutput",
  "type": "object"
}

get_recent_companies — List recently modified companies

Parameters

limit

integer

Maximum results to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "companies": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Companies",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRecentCompaniesOutput",
  "type": "object"
}

get_company_by_id — Retrieve a company by its HubSpot ID

Parameters

company_id

string

required

HubSpot company ID

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetCompanyByIdOutput",
  "type": "object"
}

create_company — Create a new company (name required)

Parameters

name

string

required

Company name

domain

string

Primary domain

industry

string

Industry

phone

string

Phone number

website

string

Website URL

properties

object

Additional properties

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateCompanyOutput",
  "type": "object"
}

update_company — Update a company's properties

Parameters

company_id

string

required

HubSpot company ID

properties

object

required

Properties to update

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateCompanyOutput",
  "type": "object"
}

get_company_activity — Get the engagement history for a company (N+1: list associations, then GET each engagement)

Parameters

company_id

string

required

HubSpot company ID

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "activities": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Activities",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetCompanyActivityOutput",
  "type": "object"
}

search_companies — Search companies by query string

Parameters

query

string

required

Search query string

limit

integer

Maximum results to return (Default: 10)

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "companies": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Companies",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchCompaniesOutput",
  "type": "object"
}

get_recent_deals — List recently modified deals

Parameters

limit

integer

Maximum results to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "deals": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Deals",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRecentDealsOutput",
  "type": "object"
}

get_deal_by_id — Retrieve a deal by its HubSpot ID

Parameters

deal_id

string

required

HubSpot deal ID

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetDealByIdOutput",
  "type": "object"
}

create_deal — Create a new deal (dealname required)

Parameters

dealname

string

required

Deal name

pipeline

string

Pipeline ID

dealstage

string

Stage ID

amount

number

Deal amount

closedate

string

Expected close date (ISO 8601)

properties

object

Additional properties

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateDealOutput",
  "type": "object"
}

update_deal — Update a deal's properties

Parameters

deal_id

string

required

HubSpot deal ID

properties

object

required

Properties to update

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateDealOutput",
  "type": "object"
}

search_deals — Search deals by query string

Parameters

query

string

required

Search query string

limit

integer

Maximum results to return (Default: 10)

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "deals": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Deals",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchDealsOutput",
  "type": "object"
}

get_recent_tickets — List recently modified tickets

Parameters

limit

integer

Maximum results to return (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "tickets": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Tickets",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRecentTicketsOutput",
  "type": "object"
}

get_ticket_by_id — Retrieve a ticket by its HubSpot ID

Parameters

ticket_id

string

required

HubSpot ticket ID

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetTicketByIdOutput",
  "type": "object"
}

create_ticket — Create a new support ticket (subject required)

Parameters

subject

string

required

Ticket subject

content

string

Ticket content

hs_pipeline

string

Pipeline ID

hs_pipeline_stage

string

Pipeline stage ID

hs_ticket_priority

string

LOW / MEDIUM / HIGH

properties

object

Additional properties

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateTicketOutput",
  "type": "object"
}

update_ticket — Update a ticket's properties

Parameters

ticket_id

string

required

HubSpot ticket ID

properties

object

required

Properties to update

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateTicketOutput",
  "type": "object"
}

search_tickets — Search tickets by query string

Parameters

query

string

required

Search query string

limit

integer

Maximum results to return (Default: 10)

properties

array

Properties to retrieve (None = default property set)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "tickets": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Tickets",
      "type": "array"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchTicketsOutput",
  "type": "object"
}

create_note — Create a note engagement (optionally associated with objects)

Parameters

body

string

required

Note body content

contact_ids

array

Contact IDs to associate

company_ids

array

Company IDs to associate

deal_ids

array

Deal IDs to associate

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateNoteOutput",
  "type": "object"
}

create_task — Create a task engagement (subject required)

Parameters

subject

string

required

Task subject

body

string

Task body

due_date

string

Due date (ISO 8601)

priority

string

Priority (NONE/LOW/MEDIUM/HIGH) (Default: NONE)

status

string

Status (NOT_STARTED/IN_PROGRESS/COMPLETED/etc.) (Default: NOT_STARTED)

contact_ids

array

Contact IDs to associate

company_ids

array

Company IDs to associate

deal_ids

array

Deal IDs to associate

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateTaskOutput",
  "type": "object"
}

create_meeting — Create a meeting engagement

Parameters

title

string

required

Meeting title

start_time

string

required

Start time (ISO 8601 or epoch ms)

end_time

string

required

End time

body

string

Meeting body

contact_ids

array

Contact IDs to associate

company_ids

array

Company IDs to associate

deal_ids

array

Deal IDs to associate

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateMeetingOutput",
  "type": "object"
}

get_property — Get a single property definition by name

Parameters

object_type

string

required

One of contacts/companies/deals/tickets

property_name

string

required

Property name to retrieve

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetPropertyOutput",
  "type": "object"
}

list_properties — List all property definitions for an object type

Parameters

object_type

string

required

One of contacts/companies/deals/tickets

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "properties": {
      "type": "array",
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Properties"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListPropertiesOutput",
  "type": "object"
}

​Overview

​Authentication

​OAuth2 Authentication

​Required Credentials

​OAuth Configuration

​Private App Access Token

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Related integrations

Clay

Dropcontact

Insightly

​Links

Overview

Authentication

OAuth2 Authentication

Required Credentials

OAuth Configuration

Private App Access Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Related integrations

Links