受信Webhookのメッセージ形式

受信Webhookのメッセージ形式

概要

この記事には、受信Webhookのメッセージ形式（パラメーター名や値の指定方法）が記載されています。
受信Webhookの基本的な説明については、こちらをご参照ください。

対応しているパラメーター

payload* - JSON
messageType - status/event/comment （初期設定の値は「status」です。）
streamId - Long
commentId - Long
attachment - file

アスタリスク（*）が表示されているパラメーター／JSONのキーは必須です。

リクエストは、「application/x-www-form-urlencoded」の形式である必要があります。形式に誤りがある場合は、エラーメッセージが生成されます。

マークダウン（書式設定の記法）のヘルプ

キー「message」の内容には、基本的なHTMLのマークダウン（書式設定の記法）を利用できます。
  1. 太字 - *内容*
  2. 斜体 - _内容_
  3. 取り消し線 - ~内容~
  4. 下線 - +内容+
  5. リンク - [内容](リンクのURL)
  6. ブロック引用 - !内容
  7. 強調表示 - `内容` 

受信Webhookを利用して投稿する方法

受信Webhookを利用して簡単なメッセージを投稿するには、以下のJSONのキーを用いてデータのパラメーターを設定します。
JSONのキー
 データの種類／形式
   説明

message*
 テキスト（文字列）
 表示するメッセージの内容
title
 テキスト（文字列）
 投稿の件名

例： 

  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    payload-{"message":"<b>Service Request</b><br><br> Your service request has been approved.Kindly contact your administrator to proceed further."}

グループには、以下のようなメッセージが投稿されます。

      


受信Webhookを利用してURLを含むメッセージを投稿する方法

URLを含むメッセージを投稿するには、以下のJSONのキーを用いてデータのパラメーターを設定します。
JSONのキー
    データの種類／形式
  説明

message*
  テキスト（文字列）
  表示するメッセージの内容
title
  テキスト（文字列）
  投稿の件名
linkUrl
 URL
 挿入したいリンクのURL

例： 

  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    パラメーター：

    payload={"title":"New Feature","message":"Learn more about how adding the Zoho Projects integration in Connect can help you increase your productivity.","linkUrl":"https://workdrive.zohopublic.in/embed/8p84z96d09596c74f482fa07e38023796922a?toolbar=false&appearance=light&themecolor=green&player=hls&socialshare=true"}


グループには、以下のようなメッセージが投稿されます。

      


受信Webhookを利用して予定の詳細を投稿する方法

受信Webhookを利用して予定を投稿するには、以下のJSONのキーを用いてデータのパラメーターを設定します。

JSONのキー
  データの種類／形式
    説明

eventTitle*

テキスト（文字列）
 予定の件名

eventDesc

テキスト（文字列）
 予定の簡単な説明

eventLocation

テキスト（文字列）
 予定の場所

startDate*

YYYY-MM-DD, HH:MM
 予定の開始日時

endDate
YYYY-MM-DD, HH:MM
 予定の終了日時 

allDay

真偽値
 予定が終日で予定されている場合は、このパラメーターを使用します。

パラメーター「messageType」は、「event」として設定する必要があります。設定されていない場合は、初期設定の値「status」（通常の投稿）が適用されます。

例：

  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    パラメーター：

    payload = {"eventTitle":"zoholics","eventDesc":"Tech event conducted between zoho developers and customers","eventLocation":"Bangalore","startDate":"2020-05-11 10:00","endDate":"2020-06-11 18:00"}

    messageType=event

グループには、以下のようなメッセージが投稿されます。
    
      
      
終日の予定の場合は、JSONのキーと値として「"allDay" : "true"」を含めるようにします。

受信Webhookを利用してコメントを追加する方法

受信Webhookを利用してコメントを投稿するには、以下のJSONのキーを用いてデータのパラメーターを設定します。

パラメーター
 データの種類／形式
 説明 
payload
JSON
JSON形式によるメッセージ

messageType*

Comment

投稿の種類 

streamId*

テキスト（文字列）

各フィードに対して設定されている専用（一意）の番号

commentId

テキスト（文字列）

返信先のコメントに対して設定されている専用（一意）の番号（コメントに対する返信としてコメントを投稿する場合）

  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    パラメーター：

    payload={"message":" your request has been assigned to @Micheal@test.com"}

    messageType=comment

    streamId = 10500041******

投稿でユーザーにメンションする方法

ユーザーにメンションするには、メールアドレスの前に「@」（アットマーク）を入力します。
例
  1. payload = {" message":"@zillum@zylker.com Please check the book cover and share your thoughts on it."," title","New book launch"}.


タグの追加方法

タグを追加するには、追加したいタグの前に「#」（ハッシュマーク）を入力します。

例：
  1. payload = {"message":"The brochure for our book launch has finally arrived! #new launch"," title","New book launch"}.

表の追加、画像の挿入など、受信Webhookのより高度な形式と機能については、こちらをご参照ください。