osFoundry / Platform
Исходящие вебхуки
Распыляйте события платформы по своим эндпоинтам. Авто-ретрай, проверка подписи.
Что это
Исходящие вебхуки позволяют osFoundry отправлять события на эндпоинты, которыми управляете вы. Вместо того чтобы опрашивать платформу в поисках изменений, вы регистрируете URL, и osFoundry шлёт на него HTTP-запрос всякий раз, когда в вашем рабочем пространстве происходит подходящее событие. Так активность в чате, у агентов, в приложениях, коде, знаниях и данных превращается в сигнал, на который могут реагировать ваши собственные системы, и при этом не нужно вручную собирать отдельную интеграцию под каждый случай.
Внутри osFoundry вебхуки находятся в разделе «Настройки и безопасность», потому что они пересекают границу доверия: они выносят события рабочего пространства наружу, к приёмнику, который принадлежит вам. Каждая доставка подписана, поэтому ваш эндпоинт может убедиться, что запрос действительно пришёл от osFoundry и не был подменён в пути. Сверьте подпись со своим общим секретом, прежде чем доверять телу запроса. Доставки, которые не удались из-за того, что ваш эндпоинт был недоступен, отвечал медленно или вернул ошибку, повторяются автоматически, а не отбрасываются, так что кратковременный сбой на вашей стороне не приводит к тихой потере событий. Поскольку osFoundry работает по принципу local-first и на ваших собственных ключах (BYOK), вебхуки — это осознанный способ вынести данные наружу, который вы включаете сами: вы решаете, какие эндпоинты получают события, а полезные нагрузки уходят только туда, куда вы их направляете.
Практическая ценность — в развязке компонентов. Вашей службе уведомлений, системе тикетов, хранилищу данных или внутренней автоматизации не нужно ни жить внутри osFoundry, ни хранить учётные данные osFoundry: достаточно выставить наружу HTTPS-эндпоинт, который проверяет подпись и возвращает статус успеха. Именно проверка подписи вместе с автоматическим повтором делают такой эндпоинт безопасным для доверия и надёжным для зависимости, и в этом разница между вебхуком, на котором можно строить рабочий процесс, и вебхуком, за которым приходится постоянно присматривать.
Ключевые возможности
- Регистрируйте собственные HTTPS-эндпоинты и получайте события платформы в момент их возникновения, без опросного цикла, который надо поддерживать
- Каждая полезная нагрузка подписана, поэтому ваш приёмник может убедиться, что запрос исходит от osFoundry, прежде чем действовать
- Неудавшиеся доставки повторяются автоматически, так что сбой на стороне получателя не приводит к тихой потере событий
- Управляется в разделе «Настройки и безопасность» как включаемый вами исходящий путь для каждого эндпоинта, полностью под вашим контролем
- Вписывается в модель local-first и BYOK: данные уходят только на те эндпоинты, которые вы явно указали
Сценарии использования
- Инженер платформы: пересылать события рабочего пространства во внутреннюю службу автоматизации, не выдавая ей учётные данные osFoundry и не встраивая её в приложение
- Эксплуатация/дежурный: направлять события в существующую систему оповещений или уведомлений, чтобы нужные люди узнавали об активности в реальном времени
- Команда данных: передавать события в хранилище или на ETL-эндпоинт, чтобы внешняя запись оставалась синхронной с тем, что происходит в рабочем пространстве
Часто задаваемые вопросы
Как убедиться, что запрос вебхука действительно пришёл от osFoundry?
Каждая доставка подписана. Ваш эндпоинт заново вычисляет подпись по телу запроса с помощью вашего общего секрета и сравнивает её с подписью, которую прислал osFoundry. Если они не совпадают, отклоните запрос. Именно это не даёт постороннему подделать события в адрес вашего эндпоинта.
Что произойдёт, если мой эндпоинт недоступен в момент события?
osFoundry повторяет доставку автоматически, а не отбрасывает её, так что кратковременный сбой или деплой на вашей стороне не приводит к потере событий. Ваш эндпоинт должен вернуть статус успеха, как только он принял полезную нагрузку.
Отправляют ли вебхуки мои данные куда-то, что контролирует osFoundry?
Нет. osFoundry работает по принципу local-first и на ваших ключах (BYOK), а вебхуки уходят наружу, на эндпоинты, которые регистрируете вы. События идут только на те URL, которые вы настроили, и какие эндпоинты существуют — решаете тоже вы. Это включаемый вами способ переносить конкретные события в системы, которые уже принадлежат вам.