仕様や画面は現行バージョンと異なる可能性があります。
Typetalkの最新版についてはこちらからご確認ください。
こんにちは！MIHOです。みなさん、ドキュメント作成サービスの「esa.io」はご存知ですか？ esa.io は「情報を育てる」という視点で作られた、マークダウン記法が使えるドキュメント共有サービスです。実は、 esaではWebhookによるTypetalkの連携機能を提供しています。本ブログでは、esa.ioとTypetalkを連携して、通知を自動化する方法についてお届けします。
esa.io のWebhookを使うと数ステップでTypetalkと連携できます
esa.ioとTypetalkを連携することで、esaで作成や更新した記事の通知をTypetalkにトピックに自動で通知することができます。議事録はesa、やり取りはTypetalk、と使い分けているプロジェクトがある方にはぜひおすすめです。まずは、esa.io側の設定手順をご紹介します！
- Typetalkと連携したいesaのチームを選択します。
- 画面の左のタブの「TEAM」を選択して、「Webhook」を選択します。（※TEAMは管理者権限を持っているユーザーのみ閲覧できます）
- 左下の「Add webhooks」を選択すると、Webhookを使ってesa.ioと連携できるサービス一覧が表示されます。そのなかから「Typetalk」を選択します。
- Typetalkを選択すると、以下の画面がでてきます。(Tips)
*「Label」は、esaのWebhook一覧画面で、いま設定しているWebhookを識別するための名前です。好きな名前をつけましょう。
*「Filter」は、Typetalkに通知する条件です。記事タイトルが正規表現に一致した場合にTypetalkに通知します。設定しなければすべての記事で通知するようになります。
Typetalk で esa ボットを作成
次にTypetalkでesaボットを作成しましょう。
- esaの更新通知を流したいTypetalkトピックを開き、トピックタイトルの右隣にあるメモパッドのアイコンをクリックしましょう。すると、トピックの編集画面が開きます。
- トピックの編集画面の「ボット」を選択して、「ボットの追加」をクリック。
- ボットのIDと名前を決めて、アイコンをわかりやすい画像に変更します。(Tips)
*名前はコメント時に表示されるので、わかりやすい名称にするのをおすすめします。
*この時に、APIスコープの「topic.post – メッセージを投稿したり、いいね！したりできます」に忘れずにチェックを入れましょう。 - すると、ボットの作成画面の下部にTypetalkトークンやコマンドサンプルが表示されます。中央の「メッセージの取得と投稿のURL」をコピーします。
esa と Typetalk を連携
さて、Typetalkでボットが作成できたので、ここからはesaに戻り、相互を連携させます。
- Typetalkとの連携画面に戻り「Post Messages URL」にURLを貼り付けます。
- Typetalkに通知したいタイミングは、チェックボックからカスタマイズできます。チェックを入れたら「Save」をクリックします。
- おめでとうございます！esaとTypetalkが連携できました！
- マークダウン記法で、議事録や報告書、設計書などの記事を作ってみましょう。「Ship It!」をクリックすると、Typetalkのトピックに通知されます。
- 私は記事を公開したときだけ通知を流すように設定したので、Typetalkのトピックには以下の内容で通知がされました！
設定手順は以上になります。文書にすると長く感じますが、実際の設定は、ボットや、Webhookを使ったことがなかった私でもすぐにできるくらい、とても簡単でした！
Typetalkのトピックに届いた通知からesaの記事に直接移動できるので、双方のサービスを確認する時間を削減できるのもうれしいポイントです。両方のサービスを日々の業務で活用している方は、この機会にぜひ試してみてはいかがでしょうか？
ちなみに、Typetalk以外にもたくさんのサービスとの連携機能を提供されているので、この機会に自分が普段使っているサービスがないかぜひチェックしてみてください:)
Typetalkでは、APIを使った外部サービスとの連携機能などの事例を積極的に発信しようと考えています。チームでオススメの活用事例や、こういった事例を知りたいといったフィードバックがありましたら、こちらのフォーラム、またはお問い合わせフォームから気軽にお問い合わせください。
今日もチームメンバーと楽しいTypetalkライフを！
参考資料：ReleaseNotes/2015/03/29/WebhookでTypetalkと連携できるようになりました – docs.esa.io