カスタムアプリやカスタムコネクト機能や仕様について説明します。
⚠️注意事項⚠️
①限定機能
2025年9月現在、「カスタムアプリ」と「カスタムコネクト」はチームプラン以上で提供しております。
チームプラン以上の無料トライアルを実施することにより、
本機能のご利用が可能なため、必要に応じて無料トライアルをお申し込みください。
トライアルについて
②サポートについて
「カスタムアプリ」と「カスタムコネクト」は、対象アプリのAPI仕様書に則って設定を行うため、
設定時に個別性の高さとAPI接続に関する専門的な知識を必要とする内容となっております。
そのため、弊社では全プランにおいて【サポート対象外】となりますため、設定・エラー発生の際は、
ご自身でAPI仕様書をご確認いただき、設定・対応いただきますようお願いしております。
🎈概要
カスタムアプリ :REST APIがあるYoomと未連携のアプリを設定できる機能です。
カスタムコネクト:API仕様書に則り、ご自身にてAPI接続を行うアクションです。
Yoomと未連携のアプリだけでなく、連携済みのアプリで用意されていないアクションの場合でも、
REST API仕様書に則り、ご自身で自由に設定することができます。
(任意のエンドポイントをリクエストすることが可能です。)
🛠️設定方法(カスタムアプリ)
1.フローボット編集画面の+ボタンを押下ください。
2.オペレーションタイプ選択画面右上の検索窓を押下し、カスタムアプリと入力します。
3.表示されますカスタムアプリを選択します。
4.カスタムコネクトアクションをご選択いただき、API仕様書に則り、カスタムコネクトをご設定ください。
⚙️仕様&設定方法 (カスタムコネクト)
設定ページでは下記の項目をそれぞれ設定する必要があります。
接続方式
API仕様書に則った接続方式を下記からご選択ください。
Get
Post
Put
Patch
Delete
Content-Type
API仕様書に則ったContent-Typeを下記からご選択ください。
application/json
application/x-www-form-urlencoded
multipart/form-data
binary
graphql
リクエストURL
下記のようにAPI仕様書に則ったエンドポイントURLを設定してください。
⚠️ ?以降のURLパラメータはこちらに記載を行わないでください。
https://api.chatwork.com/v2/rooms/xxxxxxxxxx/messages
URLパラメーター
URLパラメーターをこちらに設定してください。その際、先頭の「?」は記載を行わないようにしてください。
リクエストヘッダー
任意のリクエストヘッダーを設定してください。例えば下記のようになります。
連携済みアプリの場合、不要な場合があります。
{"Authorization": "Bearer xxxxxxxxxxxxxxxxxx"}
ボディーパラメーター
Post形式やPut形式等で送信する際に必要なボディパラメーターをJSON形式で記載してください。
例えば下記のようになります。
{
"messagae": "Hello World"
}
例)Chatworkアプリにてメッセージを送信する設定例
🎉取得した値の設定方法
カスタムコネクトでは他アクションとは異なり、必要に応じて取得した値もご自身でご設定いただく必要があります。APIのレスポンス結果から任意の値を取得する方法はこちらの記事をご確認ください。
取得した値は、以降のアクションで利用できます。
以上、カスタムアプリ/ カスタムコネクトの説明です。
#カスタムアプリ,カスタムコネクト,カスタム