Документация Webhook
Что такое Webhook
Webhook - это технология, позволяющая взаимодействовать CRM с вашими внешними скриптами по средствам передачи данных на их URL методом POST запроса(в том числе в виде отправки на них данных в формате JSON). CRM умеет передавать данные о новых созданных: сделках, задачах, клиентах, а также о их изменении и удалении.
Как подключить
Для подключения Webhook, в личном кабинете, перейдите в раздел Настройки -> Webhook, выберите "Добавить", затем заполните форму параметрами
вызова Webhook указав название, URL, тип передачи данных и при каких событиях в CRM он будет срабатывать.
При каждом изменении настроек Webhook, система отправляет тестовый запрос на указанный URL,
в качестве отправляемых данных переменная test с содержимым test.
При каких событиях вызывается
В настройках Webhook вы можете опционально задать вызов URL с передачей на него данных, при следующих событиях:
- Добавление сделки
- Редактирование сделки
- Удаление сделки
- Добавление задачи
- Редактирование задачи
- Удаление задачи
- Добавление клиента
- Редактирование клиента
- Удаление клиента
Системные значения
Время ожидания ответа от вашего сервера не более 3 секунд. Это значит, если система при отправке webhook,
не дождалась ответа от вашего сервера в течении этого времени, подключение будет сброшено.
Добавление и изменение сделки
Описание полей запроса:Переменная | Тип поля | Описание |
---|
name | string | Название сделки |
price | float | Сумма стоимости сделки |
id_cat | int | ID категории (можно получить в ЛК -> Категории сделок -> Редактировать категорию) |
id_status | int | ID статуса(шага воронки) сделки (можно получить в ЛК -> Статусы сделок -> Редактировать статус) |
id_origin | int | ID источника (можно получить в ЛК -> Источники сделок -> Редактировать источник) |
id_client | int | ID клиента (можно получить в ЛК -> Клиенты -> Редактировать клиента) |
archive | boolean | Переместить сделку в архив |
tags | string | Теги через запятую |
color | string | Цвет сделки на доске Канбан в формате HEX, пример: AD3939 |
text | string | Описание сделки |
component | string | Название компонента - order (сделки) |
event | string | Название действия - add/edit (добавление или изменение) |
Удаление сделки
Описание полей запроса:Переменная | Тип поля | Описание |
---|
id | int | ID удаляемой сделки |
component | string | Название компонента - order (сделки) |
event | string | Название действия - delete (удаление) |
Добавление и изменение задачи
Описание полей запроса:Переменная | Тип поля | Описание |
---|
name | string | Название задачи | Да |
date_from | int | Дата и время начала задачи (Unixtime) |
date_to | int | Дата и время окончания задачи (Unixtime) |
all_day | boolean | Установить задачу, как задачу периодом на весь день |
color | string | Цвет задачи на доске Канбан/Календаре в формате HEX, пример: AD3939 |
text | string | Описание задачи |
id_deal | int | ID сделки (можно получить в ЛК -> Сделки -> Редактировать сделки) |
id_status | int | ID статуса задачи (можно получить в ЛК -> Статусы задач -> Редактировать статус) |
id_type | int | ID типа задачи (можно получить в ЛК -> Типы задач -> Редактировать тип задачи) |
component | string | Название компонента - task (задачи) |
event | string | Название действия - add/edit (добавление или изменение) |
Удаление задачи
Описание полей запроса:Переменная | Тип поля | Описание |
---|
id | int | ID удаляемой задачи |
component | string | Название компонента - task (сделки) |
event | string | Название действия - delete (удаление) |
Удаление всех задач в рамках сделки
Описание полей запроса:Переменная | Тип поля | Описание |
---|
id_order | int | ID сделки в рамках которой удаляются задачи |
component | string | Название компонента - task (сделки) |
event | string | Название действия - delete (удаление) |
Добавление изменение клиента
Описание полей запроса:Переменная | Тип поля | Описание |
---|
realname | string | ФИО клиента |
email | string | E-Mail клиента |
phone | string | Телефон клиента |
position | string | Должность клиента |
id_status | int | ID статуса клиента (можно получить в ЛК -> Статусы клиентов -> Редактировать статус клиента) |
text | string | Описание клиента |
fields | array assoc | Ассоциативный массив с дополнительными полями, содежащими информацию по клиенту, где ключ - имя поля, значение - данные |
Удаление клиента
Описание полей запроса:Переменная | Тип поля | Описание |
---|
id | int | ID удаляемого клиента |
component | string | Название компонента - client (сделки) |
event | string | Название действия - delete (удаление) |
Пример скрипта принимающего данные от Webhook
Скрипт принимает данные и отправлеят их на E-Mail:
Пример 1. Скрипт принимает POST данные.
header('Access-Control-Allow-Origin: *');
$headers = "From: [email protected]";
/* замените электронную почту на действующую почту, с которой вам будет приходить письмо */
$message = print_r($_POST,true); @mail('[email protected]', 'Leve-CRM TEST', $message, $headers);
/* замените электронную почту на вашу действующую почту, на которую вам будет приходить письмо */
echo"ok";
Пример 2. Скрипт принимает JSON данные.
header('Access-Control-Allow-Origin: *');
$json = file_get_contents("php://input"); // Входящие данные в формате JSON
$data = json_decode($json, true);
$headers = "From: [email protected]";
/* замените электронную почту на действующую почту, с которой вам будет приходить письмо */
$message = print_r($data, true); @mail('[email protected]', 'Leve-CRM TEST', $message, $headers);
/* замените электронную почту на вашу действующую почту, на которую вам будет приходить письмо */
echo"ok";