HubSpot
Контакты, компании и сделки HubSpot CRM в процессах Pailot
HubSpot — облачная CRM (Customer Relationship Management — управление отношениями с клиентами): контакты, компании, сделки, тикеты и маркетинговые события.
С HubSpot в Pailot вы можете:
- Получать пользователей аккаунта
- Смотреть, искать, создавать и обновлять контакты и компании
- Получать список сделок с постраничным выводом
- Запускать процесс по событию HubSpot (создание, изменение или удаление контакта)
Нужен вход по OAuth (вход по разрешению сервиса) HubSpot. Если сервис шлёт события, включите режим триггера и скопируйте URL вебхука (входящего HTTP-запроса). Не публикуйте URL.
Блок ставят на холст как отдельный шаг или прикрепляют к агенту.
Все пользователи аккаунта HubSpot.
| Параметр | Тип | Обязательный | Описание |
|---|
limit | string | Нет | Сколько результатов вернуть (по умолчанию 100) |
| Параметр | Тип | Описание |
|---|
users | array | Пользователи HubSpot |
totalItems | number | Сколько пользователей вернулось |
success | boolean | Успешность операции |
Все контакты аккаунта с постраничным выводом.
| Параметр | Тип | Обязательный | Описание |
|---|
limit | string | Нет | Максимум на страницу (макс. 100, по умолчанию 100) |
after | string | Нет | Курсор следующей страницы |
properties | string | Нет | Свойства через запятую (например email,firstname,lastname) |
associations | string | Нет | Типы связанных объектов через запятую — вернуть их ID |
| Параметр | Тип | Описание |
|---|
contacts | array | Контакты HubSpot |
paging | object | Данные постраничного вывода |
metadata | object | Метаданные: totalReturned и hasMore |
success | boolean | Успешность операции |
Один контакт по ID или email.
| Параметр | Тип | Обязательный | Описание |
|---|
contactId | string | Да | ID или email контакта |
idProperty | string | Нет | Свойство-идентификатор (например email). Если не задано — ID записи |
properties | string | Нет | Свойства через запятую |
associations | string | Нет | Типы связанных объектов через запятую |
| Параметр | Тип | Описание |
|---|
contact | object | Контакт HubSpot со свойствами |
contactId | string | ID контакта |
success | boolean | Успешность операции |
Создать контакт. Нужно хотя бы одно из: email, firstname или lastname.
| Параметр | Тип | Обязательный | Описание |
|---|
properties | object | Да | Свойства контакта — JSON. Хотя бы одно из: email, firstname, lastname |
associations | array | Нет | Связи (компании, сделки). У каждого объекта: to (с id) и types (associationCategory и associationTypeId) |
| Параметр | Тип | Описание |
|---|
contact | object | Созданный контакт |
contactId | string | ID созданного контакта |
success | boolean | Успешность операции |
Обновить контакт по ID или email.
| Параметр | Тип | Обязательный | Описание |
|---|
contactId | string | Да | ID или email контакта |
idProperty | string | Нет | Свойство-идентификатор (например email). Если не задано — ID записи |
properties | object | Да | Свойства для обновления — JSON |
| Параметр | Тип | Описание |
|---|
contact | object | Обновлённый контакт |
contactId | string | ID контакта |
success | boolean | Успешность операции |
Поиск контактов: фильтры, сортировка и строка запроса.
| Параметр | Тип | Обязательный | Описание |
|---|
filterGroups | array | Нет | Группы фильтров. В каждой — фильтры с propertyName, operator и value |
sorts | array | Нет | Сортировка: propertyName и direction (ASCENDING или DESCENDING) |
query | string | Нет | Строка поиска |
properties | array | Нет | Имена свойств в ответе |
limit | number | Нет | Максимум результатов (макс. 100) |
after | string | Нет | Курсор следующей страницы |
| Параметр | Тип | Описание |
|---|
contacts | array | Найденные контакты |
total | number | Всего подходящих контактов |
paging | object | Данные постраничного вывода |
metadata | object | Метаданные: totalReturned и hasMore |
success | boolean | Успешность операции |
Все компании аккаунта с постраничным выводом.
| Параметр | Тип | Обязательный | Описание |
|---|
limit | string | Нет | Максимум на страницу (макс. 100, по умолчанию 100) |
after | string | Нет | Курсор следующей страницы |
properties | string | Нет | Свойства через запятую |
associations | string | Нет | Типы связанных объектов через запятую |
| Параметр | Тип | Описание |
|---|
companies | array | Компании HubSpot |
paging | object | Данные постраничного вывода |
metadata | object | Метаданные: totalReturned и hasMore |
success | boolean | Успешность операции |
Одна компания по ID или домену.
| Параметр | Тип | Обязательный | Описание |
|---|
companyId | string | Да | ID или домен компании |
idProperty | string | Нет | Свойство-идентификатор (например domain). Если не задано — ID записи |
properties | string | Нет | Свойства через запятую |
associations | string | Нет | Типы связанных объектов через запятую |
| Параметр | Тип | Описание |
|---|
company | object | Компания HubSpot со свойствами |
companyId | string | ID компании |
success | boolean | Успешность операции |
Создать компанию.
| Параметр | Тип | Обязательный | Описание |
|---|
properties | object | Да | Свойства компании — JSON (например name, domain, city, industry) |
associations | array | Нет | Связи для новой компании |
| Параметр | Тип | Описание |
|---|
company | object | Созданная компания |
companyId | string | ID созданной компании |
success | boolean | Успешность операции |
Обновить компанию по ID или домену.
| Параметр | Тип | Обязательный | Описание |
|---|
companyId | string | Да | ID или домен компании |
idProperty | string | Нет | Свойство-идентификатор (например domain). Если не задано — ID записи |
properties | object | Да | Свойства для обновления — JSON |
| Параметр | Тип | Описание |
|---|
company | object | Обновлённая компания |
companyId | string | ID компании |
success | boolean | Успешность операции |
Поиск компаний: фильтры, сортировка и строка запроса.
| Параметр | Тип | Обязательный | Описание |
|---|
filterGroups | array | Нет | Группы фильтров. В каждой — фильтры с propertyName, operator и value |
sorts | array | Нет | Сортировка: propertyName и direction (ASCENDING или DESCENDING) |
query | string | Нет | Строка поиска |
properties | array | Нет | Имена свойств в ответе |
limit | number | Нет | Максимум результатов (макс. 100) |
after | string | Нет | Курсор следующей страницы |
| Параметр | Тип | Описание |
|---|
companies | array | Найденные компании |
total | number | Всего подходящих компаний |
paging | object | Данные постраничного вывода |
metadata | object | Метаданные: totalReturned и hasMore |
success | boolean | Успешность операции |
Все сделки аккаунта с постраничным выводом.
| Параметр | Тип | Обязательный | Описание |
|---|
limit | string | Нет | Максимум на страницу (макс. 100, по умолчанию 100) |
after | string | Нет | Курсор следующей страницы |
properties | string | Нет | Свойства через запятую |
associations | string | Нет | Типы связанных объектов через запятую |
| Параметр | Тип | Описание |
|---|
deals | array | Сделки HubSpot |
paging | object | Данные постраничного вывода |
metadata | object | Метаданные: totalReturned и hasMore |
success | boolean | Успешность операции |
