Вебхуки

После определенных событий S2CRM отправляет запрос по адресу, указанному в настройках приложения.

Каждый запрос имеет тип GET и содержит в себе параметр token.

Пример запроса

GET https://myapp.com/install_webhook?token=<secret_token>

https://myapp.com/install_webhook - это адрес вебхука, указанный в настройках

token - это AccessToken пользователя, который далее можно использовать для доступа к ресурсам API.

Install Webhook

Оповещает ваш сервис о новой установке приложения.

Срабатывает сразу после того как пользователь установил приложение и одобрил запрашиваемые права доступа.

Вы можете сохранить этот токен в своей локальной базе данных и использовать его для дальнейшей аутетификации запросов к API.

Settings Webhook

Оповещает ваш сервис если пользователь изменил конфигурацию приложения в интерфейсе S2CRM.

Важно. Данный вебхук будет проигнорирован если вы используете iframe для настроек.

Пример кейса. Чтобы каждый раз не запрашивать информацию о пользовательских настройках, вы храните их в базе данных вашего приложения. После того как пользователь обновил настройки в интерфейсе S2, вы получили вебхук settings_webhook, который сообщил что настройки изменены. Теперь чтобы обновить локальную копию вам необходимо сделать API запрос на current-token (документация)

Destroy Webhook

Срабатывает когда пользователь удалил интеграцию в S2CRM.

Получив этот вебхук, вы можете деактивировать или полностью удалить все данные по пользователю.