カテゴリー
Webhook
Webhookとは
Webhookは、チャネルでイベントが発生したときにREST APIを介してサーバに通知する機能です。 このセクションには、以下のガイドが含まれます。 - チャネルでのWebhook作成方法 - Webhookのイベントタイプ - Webhookでのクイックリプライ Open API については、こちらのセクションをご覧ください。
Getting started
はじめに Webhookを作成するにはチャネルアカウントが必要です。もしお持ちでない場合は、チャネルにアクセスして、今すぐ新しいアカウントを作成しましょう😄 Webhookを作成する この機能を使用する前に、まずモデルを作成する必要があります。チャネルには複数の Webhookモデルを設定できます。その設定は、[チャネル設定] - [セキュリティ・開発] - [Webhook管理] でご確認いただけます。 Webhookにアクセスし、[Webhookを作成] をクリックし、下のボックスに入力します。 - 名前を設定します（例：Welcome Webhook） - WebhookのURLパス - 通知オプション - ユーザーチャット・イベント通知、およびグループチャット通知について：ユーザーチャット・イベント通知がオンの場合、ユーザーチャットでメッセージが入力されるとWebhookが送信されます。グループチャット通知がオンの場合、グループチャットでメッセージが入力されるとWebhookが送信されます。ただし、プライベートグループチャットやダイレクトメッセージについては、Webhookは送
Webhook Events
チャネルは現在、メッセージ作成（message creation）イベントのみを提供しています。今後、イベントを追加していく予定です。 イベントの構造 特定のイベントが発生すると、登録されたURLに対して、JSON形式のデータを含む本文でPOSTリクエストを送信します。イベントのJSON構造は以下の通りです。 - event："upsert"、"update"、"push" など、イベントのアクション（動作）を表します。 - type：イベントの対象となるモデルです。現在は "Message"、"UserChat"、"User" があります。 - entity：その type に対応する実際のモデルデータです。 - refers：他に参照すべき関連モデルがある場合、そのオブジェクトが含まれます。 新着メッセージ チャット（チームチャットまたはユーザーチャット）でメッセージが作成されると、Webhookで通知されます。Webhookにキーワードを登録している場合は、新着メッセージにそのキーワードのいずれかが含まれている場合のみ通知されます。 リクエストボディの entity は、Mess
Quick-reply for a Webhook
チャネルでは、Webhook向けのクイックリプライ機能を提供しています。Webhookのイベントリクエストに対するレスポンスを利用して、簡単にメッセージを返信することができます。 レスポンスヘッダー レスポンスを利用してメッセージを返信する場合は、カスタムHTTPレスポンスヘッダーを追加する必要があります。 "x-quick-reply" : "true" 追加しない場合、そのレスポンスはクイックリプライメッセージとして認識されません。 また、カスタムHTTPレスポンスヘッダーを使用して、クイックリプライメッセージのBot名を設定することも可能です。 "x-bot-name" : "YOUR_BOT_NAME" 設定しない場合、Bot名はチャネル名になります。 レスポンスボディ レスポンスボディは以下の形式にする必要があります。「Send a message to a Group」APIと同様の構造です。 { "blocks": [ { "type": "text", "value": "This is <b>bold</b>, <i>italic</i>, and <b><i>bol