チャット連携
espar form ではメールだけでなく、チャットサービスにメールと同じ内容を送信することができます。
以下に順に各チャットと連携する方法について記します。
Slackに連携する方法
通知メールの「メール本文」に設定した内容と同じテキストを、チャットツールSlackの任意のチャンネルに投稿させることができます。
1. Slack app を作る
slackでは、外部システムやサービスと連携するために app と呼ばれる仕組みを使います。Workspace Admin か Primary Owner 権限を持つメンバーで以下の操作をして下さい。
- (1) https://api.slack.com/apps をブラウザで開いて下さい (未ログインの場合はログインした後)
- (2) [Create New App] をクリックして下さい。表示されたダイアログで、App Name には分かり易い名称を指定、Development Slack Workspace には連携させたい Workspace を指定して下さい
- (3) app が作成されました。次に、この app を介して他システムからの投稿を受け入れるようにします。[Incoming Webhooks] をクリックして下さい。
- (4) Incoming Webhooks の詳細画面で、スイッチをOnにして、[Add new Webhook to Workspace] をクリックして下さい
- (5) 連携を求める画面が出てきますので、投稿するチャンネルを選択して [許可する] をクリックして下さい
- (6) 新たな Webhook URL が作成されます。[Copy] ボタンをクリックしてクリップボードにURLをコピーして下さい
- (7) 次に、app のアイコンや名称を設定します。サイドメニューの [Basic Infomation] をクリックして下さい
- (8) 画面を下にスクロールした先に [Display Information] という項目がありますので、App name に名称を、App Icon にアイコンを指定して下さい。ここで指定した名称とアイコンが slack 上で表示されることになります。
以上で Slack 側の準備は完了です。
2. espar admin と連携する
- (1) espar form の管理画面にログインして下さい
- (2) [フォーム] メニューをクリックし、リストボックスから目的のメールテンプレートを選択して下さい
- (3) [チャット連携] タブをクリックし、「Slack 連携を使用する」のチェックをONにして下さい
- (4) 各項目は以下の通りに入力して下さい
投稿チャンネル | 投稿するチャンネルを # 含めて入力 (#espar など) |
Webhook URL | Slack app で作成した app の Webhook URL |
投稿ユーザ名 | appの Display Information の App name を上書き指定する文字列(通常は指定不要) |
投稿ユーザアイコンURL | appの Display Information の App Icon を上書き指定するアイコン画像のURL(通常は指定不要) |
投稿ユーザアイコン絵文字 | appの Display Information の App Icon を上書き指定する絵文字を Emoji cheat sheet for GitHub, Basecamp, Slack & more の一覧から指定(通常は指定不要) |
上記画面キャプチャのように指定した場合、Chatworkには下図のように投稿されます。
Chatworkに連携する方法
通知メールの「メール本文」に設定した内容と同じテキストを、Chatworkの任意のトークルームに投稿することができます。
投稿先とするチャットIDを調べる
espar form と連携したいチャットのIDを調べます。表示できるチャットであればチャットの種類は問いません。
まず投稿先にしたい Chatwork のチャット画面をブラウザで開き、URLの末尾 #!rid
に続く数字を控えて下さい(桁数はチャットによります)
APIキーを取得する
次に、Chatwork のAPIトークンを取得します。
- (1) 画面右上のアカウントアイコンをクリックして表示されるメニューで [API設定] をクリックして下さい
- (2) テキストボックスに Chatworok のログインパスワードを入力して [表示] をクリックして下さい
- (3) API Token (32文字の英数字) が表示されますのでコピーして下さい
連携を設定する
次に、espar form と Chatwork を連携させます。
- (1) espar form の管理画面にログインして下さい
- (2) [フォーム] メニューをクリックし、リストボックスから目的のメールテンプレートを選択して下さい
- (3) [チャット連携] タブをクリックし、「Chatwork 連携を使用する」のチェックをONにして下さい
- (4) 各項目は以下の通りに入力して下さい
API Token | 取得したChatworkの API Token を貼り付けて下さい |
API URL | https://api.chatwork.com/v2/rooms/XXXXXXXX/messages を入力して下さい。XXXXXXXXの部分はチャットIDの数値に置き換えて下さい |
投稿ユーザ名 | メッセージテンプレート(後述)で使用する変数 :from がここで指定した文字列に置換されますメッセージテンプレートで変数 :from を使わない場合は省略できます |
メッセージテンプレート | Chatworkに投稿するメッセージを指定できます。変数として以下を利用できます。 ・ :from : 投稿ユーザ名の値・ :text : 通知メールに指定した「メール本文」の内容省略した場合は、 :from さんからのメッセージです。\n:text と解釈されます。 |
上記画面キャプチャのように指定した場合、Chatworkには下図のように投稿されます。
directに連携する方法
詳細は担当者にお問い合わせ下さい。 なお、directへの連携では、トークルームへの投稿文字列最大長1024文字というdirectの仕様により、1025文字目以降はdirect側で表示されません。もちろん通知・返信メールに影響が及ぶことはありませんのでご安心下さい。