ウェブフックの設定

あなたのシステムがあなたの組織に関連する変更を自動的に知らされるようにするために、APIはwebhook通知を利用します。重要なイベントが発生するたびに、 イベントリソースがWebhookレシーバーに送信されます。

ricloud-py CLIには、webhookエンドポイントのサンプル実装が含まれています。

ウェブフック設定を作成する

Webフック設定を作成するために必要な唯一のものは、APIが送信イベントを送信するURLです。

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リクエストには、リクエストの内容が変更されていないことを確認するために使用するRicloud-Signatureヘッダーが含まれています。ヘッダーには、リプレイ攻撃に対抗するために検証プロセスで使用されるタイムスタンプも含まれています。

ricloud-pyはこの署名検証プロセスの実装を含みます。