Возвращает список существующих в портале (аккаунте) хуков. Поддерживается поиск по переданному критерию.
API ver.11.0.0 Администратор
| Запрос | |||
| Параметр | Тип | Значение | Описание |
class * | String | hook | |
method * | String | get_hook_list | |
sid * | String | — | Идентификатор сессии пользователя. |
lang | String | ru | Код языка интерфейса. |
param * | Object | — | Объект с параметрами запроса. |
action | String|String[] | — | Название типа хука или массив названий типов хуков (для фильтрации). Допустимые значения: order_create order_change order_status_change order_delete contact_add contact_change contact_delete job_create job_change job_done job_delete |
title | String | — | Сервисное название хука (для фильтрации). |
status | Number | — | Текущий статус хука (для фильтрации). Допустимые значения: 0 1 |
| * – обязательные параметры | |||
| Ответ | ||
| Параметр | Тип | Описание |
response * | Object[] | Массив объектов хуков портала. |
hook_id * | Number | ID хука. |
hook_title * | String | Сервисное название хука. |
hook_action * | String | Тип события хука. |
hook_query * | String | URL обработчика или промт для AI. |
hook_status * | Number | Статус хука. Допустимые значения: 0 1 |
hook_priority * | Number | Приоритет хука. |
hook_ai_type * | Number|Null | Признак типа AI-хука. |
hook_user_id * | Number | ID создателя хука. |
hook_date_create * | Number | Дата создания хука. |
hook_date_update * | Number|Null | Дата последнего изменения хука. |
| * – обязательные параметры | ||
| Коды ошибок | |
| Номер | Описание |
708 | Недостаточно прав доступа для запрашиваемой операции. |
880 | Отсутствуют обязательные параметры или некорректные данные хука. |
881 | Хук не найден. |
883 | Неподдерживаемое событие. |
884 | Ошибка подключения или ответа внешнего сервера. |
886 | Компонента хуков недоступна или не настроена. |
887 | Ошибка при выполнении хука. |
[
{
"code": 200,
"response": [
{
"hook_id": 1,
"hook_title": "Уведомление о новой сделке",
"hook_action": "order_create",
"hook_query": "https://example.com/webhook",
"hook_status": 1,
"hook_priority": 10,
"hook_ai_type": 0,
"hook_user_id": 42,
"hook_date_create": 1740000000,
"hook_date_update": null
}
]
},
{
"code": 200,
"response": []
}
]
curl -X POST https://domain.laxo.one/hook/get_hook_list \
-H "Content-Type: application/json" \
-d '{"sid": "YOUR_API_SID", "lang": "ru", "param": "OBJECT WITH PARAMS"}