対応するパラメーターの概要
受信Webhookの基本形式では、payload、messageType、streamId、commentId、attachmentに対応しています。payloadは必須です。messageTypeにはstatus、event、commentを指定でき、省略した場合はstatusが適用されます。要求はapplication/x-www-form-urlencoded形式で送信する必要があります。
messageキーでは、基本的なHTMLマークダウンに対応しています。記号を使用して、太字、斜体、取り消し線、下線、リンク、ブロック引用、テキストのハイライトを設定できます。
|
書式
|
マークダウン
|
|
太字
|
*太字*
|
|
斜体
|
_斜体_ |
|
取り消し線
|
~取り消し線~ |
|
下線
|
+下線+ |
|
テキスト
|
[テキスト](https://example.com) |
|
引用行
|
!引用行 |
|
ハイライト
|
`ハイライトするテキスト`
|
選択したグループに通常の投稿を送信するには、ステータスメッセージを使用します。messageキーは必須で、任意でtitleも追加できます。
curl --request POST \
--url '<url got from the configuration>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'payload={'title':'Build update','message':'The deployment has completed successfully.'}'
投稿に参照元へのリンクを含めるには、payloadにmessageとlinkUrlを追加し、必要に応じてtitleも追加します。
curl --request POST \
--url '<url got from the configuration>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'payload={'title':'Release notes','message':'Read the latest release summary.','linkUrl':'https://example.com/release-notes'}'
イベントの投稿を作成するには、必須キーとしてeventTitleとstartDateを指定します。eventDesc、eventLocation、endDate、allDayも追加できます。messageType=eventを設定してください。省略すると、Webhookは要求をステータスの投稿として処理します。終日イベントの場合は、'allDay':'true'を含めます。
curl --request POST \
--url '<url got from the configuration>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'payload={'eventTitle':'Community AMA','eventDesc':'Quarterly product Q&A','eventLocation':'Online','startDate':'2026-03-20 11:00','endDate':'2026-03-20 12:00'}' \
--data-urlencode 'messageType=event'
Webhookを通じてコメントを追加するには、messageType=commentを設定し、コメント先のフィード項目を識別するstreamIdを含めます。既存のコメントに返信する場合は、commentIdも含めます。
curl --request POST \
--url '<url got from the configuration>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'payload={'message':'Please review the latest update.'}' \
--data-urlencode 'messageType=comment' \
--data-urlencode 'streamId=<stream_id>' \
--data-urlencode 'commentId=<parent_comment_id>'
ユーザーにメンションするには、メッセージ内でユーザーのメールアドレスの前に@を付けます。タグを追加するには、タグにする単語の前に#を付けます。
{'message':'@alex@example.com修正した原稿を確認してください。 #リリース'}