メインコンテンツへスキップ

Webhookドキュメント

kenji matuda
  • 更新

操作可能なユーザ権限：投稿権限、編集権限、一般権限、管理権限
ユーザ権限の詳細については「 契約内の5つのユーザ権限について 」をご参照ください。

 

Webhookは外部のシステムからTocaroのグループへメッセージを投稿するためのAPIです。
こちらではWebhookの詳細な仕様をご紹介いたします。

 

Json Format

{
    "text": "ここがtextです",
    "color": "info",
    "attachments": [
        {
            "title": "チケットタイトル",
            "value": "Support #1 からのお問い合わせ"
        },
        {
            "title": "チケット説明",
            "value": "Tocaro の WebHook で POST するパラメータを複数設定することができますか？"
        },
        {
            "title": "リクエスター",
            "value": "山田　太郎様"
        },
        {
            "title": "Tags",
            "value": "お問い合わせ"
        },
        {
            "title": "ID",
            "value": "1"
        },
        {
            "image_url": "https://dev.tocaro.im/assets/www/img_integration_inbound_webhook.png"
        }
    ]
}

 

Webhook投稿イメージ

____Tocaro_____shimura_________.png

 

各パラメータについて

フィールド 必須 型 説明
text ○ String Webhook メッセージの本文です。
color ✕ String Webhook メッセージのカラーの指定です。
attachments ✕ Array  メッセージの付加情報の指定です。

 

text フィールドについて

textフィールドにメンションを指定することが可能です。「 @all:」メンションのみ対応しています。

 

color フィールドについて

以下のエイリアスを指定するか、カラーコードを指定してください。color の指定が省略された場合は、#000d1f で表示されます。

エイリアス カラーコード
info #0065f2
success #8acf6f
warning #ffab00
danger  #d96666

 

attachments フィールドについて

以下のいずれか1つを必ず指定してください。

フィールド 型 説明
title String タイトル(太文字)
value String 内容
image_url String 画像のURL

 

 Webhookリクエストのサンプルは「WebhookでTocaroへメッセージ投稿をする」をご確認ください。

関連記事