Интеграция через входящий webhook
1. Для начала получим URL для отправки запросов. Для этого нам необходимо войти в аккаунт vionvi CRM и перейти в раздел Настройки → Источники. На открывшейся странице кликаем на кнопку добавить.
В открывшемся окне в поле Тип укажите API и напишите название (Его будут видеть менеджеры в качестве источника откуда пришел лид, например название сайта). И сохраните страницу.
Далее мы увидим URL на который необходимо отправлять запросы.
2. Отправка запроса
Необходимо отправлять POST запрос с перечислением параметров в формате JSON, кодировке UTF-8.
Параметры запроса
Необходимо отправлять POST запрос с перечислением параметров в формате JSON, кодировке UTF-8.
Параметры запроса
| Параметр | Тип данных | Описание | Обязательно | |
| name | string | Имя лида | Нет | |
| phone | string | Телефон лида | Да | |
| email | string | Email лида | Нет | |
| int | ID Ответственного сотрудника | Нет | |
| sourceId | int | ID рекламного источника | Нет |
Пример запроса с перечислением параметров:
{
"name": "test",
"sourceId": 8,
"phone": 79998888888,
"email": "fff@mail.ru",
"userIdOwner": 1
}
{
"name": "test",
"sourceId": 8,
"phone": 79998888888,
"email": "fff@mail.ru",
"userIdOwner": 1
}
Параметры ответа
| Параметр | Тип данных | Описание |
| id | int | ID созданного лида |
| name | string | Имя созданного лида |
| phone | string | Телефон созданного лида |
| email | string | Email созданного лида |
Мы используем обычные коды ответов HTTP для обозначения результата выполнения запроса.
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors
Ответ от сервера приходит в формате JSON и кодировке UTF-8.
При успешном ответе возвращаемый сервером результат будет представлен в теле ответа массивом data.
При ошибке выполнения запроса вы можете получить в теле ответа массив errors
Пример ответа:
HTTP/1.1 201 Created
Server: nginx/1.21.6
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.1.3
Cache-Control: no-cache, private
Date: Tue, 26 Jul 2022 10:18:12 GMT
X-RateLimit-Limit: 100000
X-RateLimit-Remaining: 99999
Access-Control-Allow-Origin: *
Server: nginx/1.21.6
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.1.3
Cache-Control: no-cache, private
Date: Tue, 26 Jul 2022 10:18:12 GMT
X-RateLimit-Limit: 100000
X-RateLimit-Remaining: 99999
Access-Control-Allow-Origin: *
{"data":{"id":16,"name":"test","sourceId":8,"contractId":null,"phone":"79998888888","email":"fff@mail.ru","commentDelete":null,"notAnswer":null,"userIdCreate":1,"userIdUpdate":null,"userIdDelete":null,"dtCreate":"2022-07-26T10:18:12.000000Z","dtUpdate":"2022-07-26T10:18:12.000000Z","dtDelete":null,"dtNotAnswer":null,"status":null,"locationUnitId":null,"userIdOwner":"1"},"success":true}