Вебхуки
Как получать уведомления о новых сообщениях и беседах во внешней системе
Вебхук отправляет уведомление во внешнюю систему, когда в А5Клиент появляется новое сообщение или беседа. Например, так Ваша программа может узнавать о новых обращениях.
Перед настройкой получите у специалиста адрес для приёма уведомлений. Если интеграция использует секрет для проверки отправителя, его тоже нужно согласовать заранее.
Как добавить вебхук
Откройте форму
В разделе «А5Клиент API» найдите блок «Вебхуки» и нажмите «Добавить вебхук».
Укажите адрес и секрет
В поле «URL вебхука» вставьте адрес, который подготовлен для Вашей интеграции. Это должен быть доступный из интернета адрес с http:// или https://. Адрес локального компьютера не подойдёт.
«Секрет» нужен, чтобы принимающая система могла проверить, что уведомление пришло от А5Клиент. Укажите согласованное значение или оставьте поле пустым, если интеграция его не использует.
Выберите события
По умолчанию включены оба события:
| Событие в форме | Для чего нужно |
|---|---|
| message.created — Новое сообщение | Получать уведомления о новых сообщениях. |
| thread.created — Новая беседа | Получать уведомления о новых беседах. |
Снимите галочку с события, которое не нужно интеграции. Если снять обе, уведомления отправляться не будут.
Включите и сохраните
Оставьте статус «Активен» и нажмите «Создать». Вебхук появится в списке.
Если хотите сохранить настройки, но пока не получать уведомления, выберите «Отключен».
Как изменить или отключить вебхук
Нажмите «Редактировать» напротив нужного адреса. В форме можно поменять адрес, секрет, события и статус. После изменений нажмите «Сохранить».
Чтобы приостановить уведомления, выберите «Отключен» и сохраните форму. Для возобновления верните «Активен».
Если вебхук больше не нужен, нажмите «Удалить» в списке и подтвердите удаление.
Если не получается сохранить
Проверьте адрес: он должен быть полным и доступным из интернета. Один и тот же адрес нельзя добавить дважды. Если появилось сообщение «Вебхук с таким URL уже существует», найдите его в списке и откройте «Редактировать».
Если уведомления не приходят
Откройте вебхук через «Редактировать» и проверьте статус и галочки событий. Также должны быть включены доступ к API и учётная запись А5Клиент, а аккаунт, по которому приходят сообщения, должен работать без ошибок.
Статус «Активен» означает, что вебхук включён. Он не подтверждает, что внешняя система приняла уведомление. Проверить приём по указанному адресу поможет специалист, который настраивал интеграцию.