💡 この機能は、Business以上プランの契約プロジェクトでご利用いただけます |
STUDIO では以下のタイミングに Webhook 通知を実行しております。
サイト公開時
サイト更新時
サイト非公開時
Webhook の通知は、現在１プロジェクトごと、１URLまで設定可能です。
設定方法
有効にする
プロジェクトダッシュボード「全体設定」にアクセスしてください
Webhook の編集ボタンを押し、エンドポイントを入力して「保存」するとWebhookがONになります。
ONになったあと、「テスト送信」を押し、動作を確認してください
無効にし、通知を止める
プロジェクトダッシュボード「全体設定」にアクセスしてください
Webhook の編集ボタンを押し、エンドポイントの値を空文字で保存してください。正常に完了すると、ステータスもOFFになります。
実行時の挙動
プロジェクトが通知条件を満たすと、指定された URL に対して以下の POST を行います。
その際、値はそれぞれ以下のようになります。
Content-Type: application/json
User-Agent: STUDIO-Webhook
Body: {JSON}
Body の JSON の内容は以下のようになります。なお、読みやすいように改行を入れていますが、実際には1行で、プロパティ名と値の間には空白は入りません。
{
"project_id": "xxxx",
"project_name": "テストプロジェクト名",
"event": "site-published",
"user_id": "xxxx",
"user_name": "xxx xxx",
"dashboard_url": "https://app.studio.design/projects/xxxxx",
"publish_url": "https://example.com",
"timestamp": 1711582925
}
project_id:
project_idは、プロジェクトを一意に示す ID です。project_name:
project_nameは、プロジェクトの名称になります。event:
eventは、 Webhook の通知されるイベント名になります。現時点では、site-published(サイトの公開)、site-unpublished(サイトの非公開)、site-updated(サイトの更新)user_id:
user_idは、ユーザーを一意に示す ID です。user_name:
user_nameは、ユーザーの名称になります。dashboard_url:
dashboard_urlは、STUDIOのプロジェクトダッシュボードの URL になります。publish_url:
publish_urlは、公開サイトの URL になります。timestamp:
timestampは、UNIX タイムスタンプになります。
Slack の incoming webhooks のエンドポイントを設定した場合
Slack の incoming webhooks をエンドポイントに設定した場合、STUDIO では自動的に通知条件に応じて下記内容の Slack 通知が送信されます。
※ Webhook を設定したSTUDIOユーザーの言語設定が反映されます。
通知の様子（サイト公開・更新・非公開）：
💡 外部サービスの動作について、テクニカルサポート窓口ではサポートいたしかねます。STUDIOコミュニティでの質問や過去の投稿をご参考ください。 |