Webhook
Webhook機能を使用すると、コンテンツの作成、更新、削除が行われた際に、指定したURLに通知を送信できます。これにより、外部システムやサービスとの連携が可能です。
機能
- コンテンツの作成、更新、削除を通知
- カスタムリクエストヘッダーに対応
- HTTPSでセキュアな通信
設定方法
Orizmコンソールのプロジェクト設定からWebhookを設定できます。
プロジェクト設定を開く
Webhook設定を開く
Webhookの作成をクリック
Webhookの作成
| プロパティ名 | 概要 |
|---|---|
| Name | コンソール上の表示用です |
| URL | 指定したURLにPOSTリクエストでイベントを通知します |
テーブルとイベントを選択
Table Events で通知を受け取るテーブルとイベントを選択します。
Add Table Eventをクリックするとテーブルを追加しますAdd All Tablesをクリックすると全てのテーブルを追加します
特定のイベント通知が不要な場合は、チェックボックスを解除することで通知を無効にできます。
Save をクリックすると設定が保存されます。
カスタムリクエストヘッダー
Custom Request Headers で必要に応じて、HTTPリクエストに任意のヘッダーを追加できます。
サポートしているイベント
| イベント名 | 説明 |
|---|---|
content.create | コンテンツが新規作成された時 |
content.update | コンテンツが更新された時 |
content.delete | コンテンツが削除された時 |
Webhookペイロード
Webhookがトリガーされると、指定したURLにPOSTリクエストで以下のようなJSON形式のデータが送信されます。
{
"event": "content.create",
"timestamp": "2025-01-01T00:00:00.000Z",
"project": "projectName",
"table": "tableName",
"content": {
"id": "xxxxxxxx"
...
},
"old": {
"id": "xxxxxxxx"
...
}
}event
トリガーされたイベントの名前です。サポートしているイベント のイベント名が入ります。
timestamp
イベントの発生時刻です。
ISO 8601形式で表現されます。（例: 2025-01-01T00:00:00.000Z）
project
イベントが発生したプロジェクト名です。
table
イベントが発生したテーブル名です。
content
イベントが発生した際のコンテンツです。
old
イベントが発生した際の変更前のコンテンツです。
content.update イベントの場合のみ存在します。