Webhookを作成しておくことで、コンテンツの情報を外部システムと連携することができます。

Webhookの作成・設定

スペース設定の「Webhook」から作成・設定ができます。

基本設定

Webhook名

任意の名称を入力してください。

リクエストURL

Webhook実行時に、登録したURLに対してPOSTリクエストが送信されます。

ステータス

Webhookの有効/無効を切り替えることができます。

コンテンツ詳細画面に手動実行ボタンを設置

コンテンツ編集画面で手動でWebhookを実行できるよう設定できます。

詳細は後述します。

トリガー設定

トリガー

どのタイミングでWebhookを実行するか、トリガーを設定することができます。

詳細は後述します。

トリガーの対象モデル

Webhookのトリガー対象とするモデルを指定することができます。

• 「すべて」
  • スペース内の全てのコンテンツが対象となります
• 「指定」
  • 選択したモデルに該当するコンテンツが対象となります
  • 複数選択が可能です

トリガーの対象言語

Webhookのトリガー対象に言語を指定することができます。

• 「すべて」
  • コンテンツ内のすべての言語がトリガー対象となります
• 「指定」
  • 選択した言語に対するコンテンツ操作がトリガー対象となります
  • 複数選択が可能です

詳細は後述します。

リクエスト内容

ヘッダー

• ヘッダー
  • 任意のヘッダーを追加できます
• シークレットヘッダー
  • 管理画面上に値が表示されないヘッダーを付与できます

Payload（JSON形成）

Webhook送信時のPayload内容を設定します。

{{content._id}}のような記法で、コンテンツの情報や内容をペイロードに取り込むことができます。
詳細はプレースホルダー記法をご確認ください。

コンテンツ詳細画面に手動実行ボタンを設置

作成したWebhookを、コンテンツ詳細画面から手動で実行することができます。

「コンテンツ詳細画面に手動実行ボタンを設置」オプションで、手動実行したいコンテンツのステータスを指定します。

• しない
  • どのステータスのコンテンツでも、リストに表示されません
• 下書きのみ
  • 「下書き」コンテンツ表示時にのみ、リストに表示されます
• 公開中のみ
  • 「公開」コンテンツ表示時にのみ、リストに表示されます
• 下書きと公開中
  • 「下書き」および「公開」いずれのコンテンツ表示時にも、リストに表示されます

また、「トリガーの対象モデル」オプションの設定にも従います。
指定モデルのコンテンツ表示時のみ、作成したWebhookがリストに表示されます。

トリガー

どのタイミングでWebhookを実行するか、トリガーを設定することができます。

• コンテンツを公開
  • コンテンツの「公開」または「上書き公開」
• コンテンツを非公開
• コンテンツの下書きを保存
• コンテンツをアーカイブ
• コンテンツをアーカイブから復元
• アーカイブされていないコンテンツを削除
  • 「下書き」または「公開」のコンテンツを、アーカイブを介さず削除したとき
• アーカイブされたコンテンツを削除
  • 「アーカイブ」のコンテンツを削除
• 参照しているメディアを変更
  • 参照しているメディアを変更したことにより、参照中コンテンツに変更が反映されます
  • 変更されたコンテンツの分、Webhookが送信されます
• コンテンツの公開日時を変更
  • コンテンツの「公開日時を編集」から「公開日時」または「最終公開日時」を変更したとき

トリガーの対象言語

Webhookのトリガー対象に言語を指定することができます。

Payloadへのプレースホルダー記法指定時に、言語ごとの内容で置換することができます。
置換のルールは、トリガーとなる操作ごとに以下のように異なります。