表示モード
メッセージ連動Webhook
マイルーム／ルーム／コンタクトの「Webhook管理」で設定したWebhookは、メッセージを送信したとき送信されます。
メッセージ送信時にWebhookを送信する準備
マイルーム／ルーム／コンタクトでメッセージを送信したときにWebhookを送信するには、
以下のWebhookの利用設定と追加を行う必要があります。
システム管理者権限のユーザーで「Webhook利用設定」を「利用する」に設定
- システム管理者権限のユーザーでログインし、システム管理者設定画面を表示します。
- 左側のメニューから、「基本設定」の「Webhook利用設定」を選択します。
- 対象のチャット種別に対してWebhook利用を「利用する」に設定します。
各チャットの「Webhook管理」からWebhookの追加
※ 追加するにはシステム管理者権限のユーザーで「Webhook利用設定」を「利用する」に設定する必要があります。
- 任意のユーザーでログインし、対象のチャットの「Webhook管理」ウィンドウよりWebhookを設定します。
※ ルームの場合、ルーム管理者権限を持つユーザーでのみWebhookの設定ができます。 - Webhookの通信先URLなど必要な項目を設定後、「テスト送信」ボタンをクリックして送信先との通信確認を行います。
「テスト送信に成功しました。」と表示された場合、設定は完了です。
仕様
メッセージ送信時にWebhookによる通信に失敗しても、画面上にはエラーは表示されません。
Webhookの送信が正常に行われない場合は、上記「メッセージ送信時にWebhookを送信する準備」に記載の
「テスト送信」による通信確認が成功するかご確認ください。
Webhookの通知内容
マイルーム／ルーム／コンタクトでメッセージを送信したとき、Webhookによる通知の内容は以下の通りです。
※ Webhookの送信内容は、「カスタムヘッダー」および「カスタムボディ」の設定に応じて変更できます。
※ Webhookのパラメータのフィールド名も変更可能です。
ここでは説明のために代表的なフィールド名を使用しています。実際の設定に応じて適宜読み替えてください。
※ カスタムヘッダーのサンプルは省略しています。
※ 以下の表は、「カスタムボディ」で設定可能な値を例として記載しています。
HTTPリクエストの情報：
- method : POST
- content-type : application/json
リクエスト内容
| フィールド名 | フィールド値 | 備考 |
|---|---|---|
| chat_id | チャットのシステムID | メッセージが投稿されたチャット(マイルーム／ルーム／コンタクト)のシステムID。 「カスタムボディ」で「チャットID」を選択した場合送信されます。 |
| chat_name | チャット名 | メッセージが投稿されたチャット名(マイルームの場合はユーザー名)。 「カスタムボディ」で「チャット名」を選択した場合送信されます。 |
| user_id | ユーザーのシステムID | メッセージを投稿したユーザーのシステムID。 「カスタムボディ」で「送信者のユーザーID」を選択した場合送信されます。 |
| user_name | ユーザー名 | メッセージを投稿したユーザーの氏名。 「カスタムボディ」で「送信者のユーザー名」を選択した場合送信されます。 |
| message_id | メッセージのシステムID | 投稿されたメッセージのシステムID。 「カスタムボディ」で「メッセージID」を選択した場合送信されます。 |
| message_text | メッセージの内容 | 投稿されたメッセージの内容。 「カスタムボディ」で「メッセージ」を選択した場合送信されます。 |
| sent_at | メッセージの送信日時 | メッセージが送信された時間(UTC)。 「カスタムボディ」で「送信日時」を選択した場合送信されます。 |
| custom_value | (自由入力) | 「カスタムボディ」で「(自由入力)」を選択した場合、入力した値が送信されます。 |
| optional_value | (なにも送信しない) | 「カスタムボディ」で「(なにも送信しない)」を選択した場合、「null」が送信されます。 |
送信内容(リクエストボディ)の例
jsonc
{
"chat_id": "1wgok40sx4ws",
"chat_name": "情報セキュリティ委員会",
"user_id": "1wglquducr5y",
"user_name": "山田太郎",
"message_id": "1lqolwigavls",
"message_text": "(ここに送信したメッセージ内容が入ります)",
"sent_at": "2026-02-27T06:56:49Z",
"custom_value": "any fixed value",
"optional_value": null
}