Вебхуки плагинов
Как доставлять внешние события плагину, включённому в организации, и что проверяет адрес до того, как плагин их увидит.
Плагин, который объявляет поддержку вебхуков, получает внешние события по адресу:
POST https://intelligence-api.veyra.so/api/plugins/{pluginId}/webhooks/{endpointKey}endpointKey называет один из адресов, объявленных плагином в манифесте. Адреса показаны на странице настроек плагина.
Что Veyra проверяет сначала
| Проверка | Если не прошла |
|---|---|
| Плагин существует. | 404 |
| Плагин готов (включён и запущен). | 400 с его текущим статусом |
| Плагин объявляет поддержку вебхуков и этот адрес. | 400 или 404 |
Затем плагин сам проверяет запрос (например, по подписи отправляющего сервиса) и решает, что с ним делать. Ожидаемая полезная нагрузка описана в его документации.
Аутентификация
Способ аутентификации вебхука определяет плагин. Выбирайте плагины, которые проверяют подпись отправителя; сам адрес не стоит считать секретом.
См. раздел Плагины в справочнике API.