Webhook

Webhookとは

Webhookを利用すると、Newtのコンテンツが変更された時に、カスタマイズされたHTTPリクエストを送信できます。

例えば、以下のような場合に利用できます。

  • コンテンツが更新された時に、静的なサイトをデプロイする
  • 外部の検索サービスにデータを同期する
  • Slackにメッセージを送信する

トリガー

Webhookは、トリガーを設定することが可能です。
「全モデルのコンテンツ」を選択した場合、スペース内の全てのコンテンツの公開・非公開が変更された時、および公開コンテンツの更新時にリクエストが送信されます。
「特定モデルのコンテンツ」を選択した場合、選択したモデルに該当するコンテンツの公開・非公開が変更された時、および公開コンテンツの更新時にリクエストが送信されます。

Webhookのカスタマイズ

ヘッダー

デフォルトでは、以下のヘッダーが設定されます。

フィールド名
Content-Type application/json

さらに追加したいフィールドがある場合、フィールドを追加することが可能です。

シークレットヘッダー

もし、管理画面上に値を表示したくないヘッダーがある場合、「シークレットヘッダー」としてフィールドを追加してください。こちらに設定された場合、1度保存した後は管理画面上に値が表示されません。

ペイロード

ペイロードをカスタマイズすることも可能です。有効なJSONを入力してください。

アクティビティログ

アクティビティログでは、送信されたリクエストのログを確認できます。
最新100件のリクエストについて、送信日時とレスポンスのステータスが表示されます。

手動実行

「今すぐ実行」ボタンをクリックするとトリガーを介さずに直接Webhookを実行できます。
※ステータスが「停止」でも、手動での実行は可能です。

webhook_button.jpg

Newt Made in Newt