Как настроить Webhook

Синхронизация и API

Webhook — это механизм оповещения системы о каких-либо событиях. То есть Callibri может оповещать сторонние системы о том, что пришло письмо, совершен звонок и т.д. Это позволяет строить статистику на основе данных за пределами отчетов Callibri.

Webhook при срабатывании события автоматом отправляет запрос с данными в виде JSON.

JSON (JavaScript Object Notation) — простой формат обмена данными, удобный для чтения и написания как человеком, так и компьютером. Он основан на подмножестве языка программирования JavaScript, определенного в стандарте ECMA-262 3rd Edition - December 1999.

Пример:

{
   "firstName": "Иван",
   "lastName": "Иванов",
   "address": {
       "streetAddress": "Московское ш., 101, кв.101",
       "city": "Ленинград",
       "postalCode": 101101
   },
   "phoneNumbers": [
       "812 123-1234",
       "916 123-4567"
   ]
}

Как включить отправку вебхуков

Перейдите в раздел Настройки проекта — Синхронизации — Вебхуки и нажмите кнопку Создать вебхук:

Откроется окно, в котором нужно заполнить данные:

Введите адрес, на который будут отправляться вебхуки.
Выберите метод передачи данных (GET или POST).
Выберите событие, которое нужно передавать (Звонок, Чат, Заявка, Емайл, все).
Выберите передаваемые параметры.
Сохраните изменения
Отправьте тестовый вебхук и убедитесь, что он пришел на адрес из пункта 1.
Подтвердить отправку данных

Вебхук появится в списке

Если в дальнейшем сервер окажется недоступен и будет возвращать ошибку, то мы отключим вебхук и отправим email-уведомление об этом на почту администратора проекта. В этом случае вам нужно проверить работу сервера, а затем включить вебхук заново.

Если вам необходимо, чтобы в передаваемых данных были metrika_client_id и ua_client_id, необходимо включить синхронизации (с Метрикой и Аналитиксом соответственно). Включение синхронизации активирует сбор этих ID.

Связанные страницы

Документация по API

Не нашли решение проблемы? Обратитесь в техподдержку, мы поможем

Создать обращение