Вебхуки

Обзор и события

Вебхук уведомляет ваш сервис об изменениях в Базах. Владелец или админ регистрирует URL и события; при наступлении события База отправляет POST с данными записи.

#События

record.created — создана запись.
record.updated — изменена запись.
record.deleted — удалена запись.
* — все три события.

#Управление

http

GET    /api/workspaces/{ws}/webhooks              # список
POST   /api/workspaces/{ws}/webhooks              # создать
PATCH  /api/workspaces/{ws}/webhooks/{id}         # изменить url/события/активность
DELETE /api/workspaces/{ws}/webhooks/{id}         # удалить

bash

curl -X POST https://ВАШ_ДОМЕН/api/workspaces/{ws}/webhooks \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"url":"https://example.com/hook","events":["record.created","record.updated"]}'

В ответ приходит вебхук с полем secret — его нужно сохранить для проверки подписи входящих запросов.

#Активность

У вебхука есть флаг active (изначально true). Выключенный вебхук события не получает, но конфигурация и секрет сохраняются.