---

Как подключить внешнюю систему через вебхук

Вебхук — уведомление, которое Система Оптима сама отправляет на адрес внешней системы, когда происходит выбранное событие. Чтобы подключить внешнюю систему, откройте «Настройки интеграции» → «Вебхуки», нажмите «Добавить» и укажите адрес, ключ и события. Затем передайте ключ и ссылку на документацию разработчику внешней системы. Доходят ли уведомления, видно в «Истории вызовов».

Доступно пользователям с уровнем доступа «Системный администратор».

Статья о том, как Система Оптима сама отправляет уведомления во внешнюю систему. Как внешняя система запрашивает данные из Системы Оптима — см. API Системы Оптима. Электронный документооборот с поставщиками подключается иначе — см. Как подключить электронный документооборот с поставщиком.

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

1. Узнайте у разработчика внешней системы адрес (URL), на который нужно отправлять уведомления. Без адреса вебхук не сохранится.
2. Откройте в левом меню «Настройки интеграции» и перейдите на вкладку «Вебхуки». Откроется список вебхуков вашей компании.

1. Нажмите «Добавить». Справа откроется панель «Добавить интеграцию».

1. В поле «Название интеграции» введите понятное название, например имя внешней системы. Оно не должно совпадать с названием уже созданного вебхука.
2. В поле «URL вебхука» вставьте адрес из шага 1 без «https://» — эта часть уже стоит в поле. Уведомления отправляются только на адреса, которые начинаются с https.
3. В поле «API ключ / Secret» (API — программный интерфейс) введите ключ от разработчика или нажмите «Сгенерировать». Ключ уходит вместе с каждым уведомлением: по нему внешняя система проверяет, что уведомление пришло из Системы Оптима.
4. В блоке «События для отправки» отметьте события, о которых нужно сообщать внешней системе, например «Событие создания события (EventCreated)». Какие события нужны, уточните у разработчика внешней системы.
5. Нажмите «Сохранить». Вебхук появится в списке и сразу станет активным.
6. Передайте разработчику внешней системы ключ и ссылку на документацию. Ключ скопируйте в списке значком копирования в столбце «API ключ». Ссылку скопируйте в блоке «Документация» панели вебхука: https://docs.itigris-optima.ru/webhooks. Разбираться в документации самим не нужно, она для разработчика.

Как изменить или удалить вебхук

Изменить вебхук

1. На вкладке «Вебхуки» щёлкните по строке вебхука. Откроется та же панель с заполненными полями.
2. Измените поля или отметки событий и нажмите «Сохранить». Список обновится.

Удалить вебхук

1. На вкладке «Вебхуки» нажмите значок удаления в строке вебхука.
2. Подтвердите удаление. Вебхук исчезнет из списка, уведомления на его адрес больше не отправляются. Записи о прошлых отправках останутся в «Истории вызовов».

Как проверить, что уведомления доходят

1. На вкладке «Вебхуки» нажмите «История вызовов». Откроется экран «История вызовов вебхука/интеграции».
2. В поле «Период событий» выберите даты. По умолчанию показан сегодняшний день.
3. Найдите строки нужного вебхука по столбцу «Название». «Успешно» в столбце «Статус» значит, что внешняя система приняла уведомление, «Ошибка» — что не приняла.
4. Чтобы вернуться к списку вебхуков, нажмите стрелку слева от заголовка.

Важно

Важно. Выключить вебхук нельзя: после сохранения он всегда активен. Чтобы остановить уведомления, удалите вебхук. Удаление не отменить. Чтобы подключить внешнюю систему снова, создайте вебхук заново и передайте разработчику новый ключ, если старый не сохранился.

Обратите внимание. В «Истории вызовов» каждая попытка отправки — отдельная строка. Если внешняя система временно недоступна, Система Оптима повторяет отправку несколько раз. Поэтому у одного события может быть несколько строк «Ошибка», а за ними «Успешно».

Обратите внимание. Если оставить поле «API ключ / Secret» пустым, внешняя система не сможет проверить, что уведомление пришло из Системы Оптима. Если не отметить ни одного события, уведомления не будут отправляться вовсе.

Обратите внимание. Ключ виден в списке всем пользователям с уровнем доступа «Системный администратор». Не передавайте его посторонним: с ключом можно отправить внешней системе поддельное уведомление от имени Системы Оптима.

Если не получилось

Проверьте по порядку, если у вебхука в «Истории вызовов» только «Ошибка» или записей нет совсем.

• Откройте вебхук щелчком по строке и сверьте адрес в поле «URL вебхука» с тем, что дал разработчик.
• Если записей нет, проверьте «Период событий» и отмеченные события. Уведомление отправляется, только когда выбранное событие происходит.
• Если адрес верный, а в статусе «Ошибка», передайте разработчику внешней системы название вебхука, дату и время записи. Он проверит, почему внешняя система не приняла уведомление.
• Если не помогло, обратитесь в техподдержку ИТигрис и укажите название вебхука и время записи с ошибкой.

Связанные статьи

• API Системы Оптима
• Что доступно пользователю с уровнем доступа «Системный администратор»
• Как подключить электронный документооборот с поставщиком