JANDIコネクト‘ウェブフーク’(Incoming Webhook)で外部データをJANDIメッセージで受信する

JANDIコネクト‘ウェブフーク’(Incoming Webhook)で外部データをJANDIメッセージで受信する

Webhookとは?

ウェブフーク(Webhook)とはJANDIでJANDIが決めたフォーマットと一致するデータを受信して指定された会話にメッセージ形態で伝送する機能を言います。現在JANDIコネクトで支援していないサービスでも該当サービスでウェブフーク発信(Outgoing Webhook)を支援する場合、JANDIと連携させて変動事項についてメッセージを受信することができます。

*Tip:開発者またはIT部署職員の助けをもらうとより易しく設定できます。

STEP1
この機能を使うためには設定時作成されるウェブフークアドレスに受信したい情報(HTTP POST request)を伝送してください。

requestには必ずAcceptとContent-Typeを次のように指定しないといけないです。

Accept: application/vnd.tosslab.jandi-v2+json
Content-Type: application/json
ご参考:JANDIウェブフークはrestful APIで作動するためhttp methodをPOSTに指定さないといけないです。他のmethodで発送する場合作動しません。

STEP2
POST requestのフォーマットは次のようです。

{
"body" : "[[PizzaHouse]](http://url_to_text) You have a new Pizza order.",
"connectColor" : "#FAC11B",
"connectInfo" : [{
"title" : "Topping",
"description" : "Pepperoni"
},
{
"title": "Location",
"description": "Empire State Building, 5th Ave, New York",
"imageUrl": "http://url_to_text"
}]
}

各フィールドの役割は次のようです。

- “body”:一般的なメッセージの内容です。JANDIでメッセージを作成して伝送すると表示されるビューに受信されます。
このフィールドは雄一な必須項目で、このフィールドの内容がない場合メッセージは発生しません。
その他フィールドを提供していなくてもこのフィールドにもメッセージの発声ができます。
[[PizzaHouse]](http://url_to_text) ▸ 上の例示はJANDIで提供するリンクマークダウン(ハイパーリンクを作ってくれるテキストフォーマットでJANDIでは“[テキスト](URLリンク)”のように構成する場合クリックすると新しいウィンドウが開くリンクを作成できます。)を適用した例です。

- “connectColor”:上のサンプルメッセージで本文メッセージ下段の別の領域に区分される添付領域部分のカラー値をHex codeで指定することができます。


- “connectInfo”:上のサンプルメッセージで添付領域にどんな内容が入るかを正義する部分です。


- “title”:添付領域のタイトルで、基本的に太字に表示されます。


- “description”:添付領域の詳細内容です。上の例示のようTitleとDescriptionはメッセージ構造によって複数を追加できます。


- “imageUrl”:該当ウェブフークメッセージに添付されたイメージファイルがある場合、URLとして添付させることができます。おってURLに該当するイメージのサムネールをメッセージと共に提供する予定です。
次はcurl requestのサンプルです。ターミナルなどのコマンドライン環境(CLI)で実行する場合JANDIで実際メッセージを受信するのを見ることができます。

ただ、テキストの前下のhttps://wh.jandi.com/connect-api/webhook/作成したーウェブフークーアドレス 部分を実際にJANDIで作成したウェブフークアドレスを代替することを忘れないでください。

curl \
-X POST https://wh.jandi.com/connect-api/webhook/作成したーウェブフークーアドレス \
-H "Accept: application/vnd.tosslab.jandi-v2+json" \
-H "Content-Type: application/json" \
--data-binary '{"body":"[[PizzaHouse]](http://url_to_text) You have a new Pizza order.","connectColor":"#FAC11B","connectInfo":[{"title":"Topping","description":"Pepperoni"},
{"title":"Location","description":"Empire State Building, 5th Ave, New York","imageUrl":"Url_to_text"}]}'

このように受信されたメッセージは該当ウェブフークを作成した会話に次のように伝送されます。

Screen_Shot_2016-06-20_at_12.13.53_PM.png

プロフィールイメージは名前の変更をご希望の場合JANDIコネクト修正画面ですぐ修正できます。

Tip!

お客様がご使用するサービスの中で、ウェブフークを支援するサービスがあるとしても該当サービスで発生するイベントをJANDIがメッセージで構成できるフォーマットに毎度転換させないと正常的な受信ができません。この役割をするプロセスを直接開発することもありますが、Zapierのようなサードパーティサービスを通して設定ができます。
JANDIで表示できるメッセージの最大文字数は5000字で、ウェブフークで受信できる最大データストレージは256kbです。256kbは26万文字を超える大きさでとして一般的に使うには十分ですが、この以上のデータを受信するとエーラーメッセージを変換します。具体的には、25万文字くらいのメッセージをウェブフークで発送した時、5000字まで表示されます。
もし27万文字を発送するとメッセージ自体が発生できません。

またご不明な点やご意見がございましたらJANDIヘルプセンターよりお問い合わせください。

コメント

Powered by Zendesk