Настройка веб-хуков

API использует webhook notificatiosn для автоматического информирования вашей системы об изменениях, связанных с вашей организацией. Ресурс события отправляется вашему получателю webhook всякий раз, когда происходит значительное событие.

CLI- интерфейс ricloud-py содержит примеры реализаций конечной точки webhook.

Создание конфига webhook

Единственная вещь, необходимая для создания конфигурации webhook - это URL, на который API будет отправлять исходящие события.

ricloud-py реализует вспомогательную команду:

> ricloud webhook-config create --url "<webhook receiver URL>"

Эквивалентный вызов cURL будет выглядеть так:

curl https://ricloud-api.reincubate.com/configs/webhook \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "<webhook receiver URL>"
}'

Ответ на этот запрос будет содержать secret webhook, который будет важен для обеспечения реализации вашего приемника webhook в производстве.

Проверка подписей событий

Каждый запрос webhook включает заголовок Ricloud-Signature который следует использовать для проверки того, что содержимое запроса не было изменено. Заголовок также содержит временную метку, которая используется в процессе проверки для противодействия атакам воспроизведения.

ricloud-py включает в себя реализацию этого процесса проверки подписи.