Qiita TeamのWebhookを少し改善しました

こんにちは、r7kamura です。暑い日が続きますが皆様イカがお過ごしですか。

Qiita Teamでは、メンバーが新しく追加されたときや、記事を作成したときなどに、予め登録しておいたURLに対してHTTPリクエストを送信するWebhookという機能を提供しています。このたび、Qiita TeamのWebhookの機能に少し改善を加えたのでお知らせします。

認証用トークン

本当にQiita Teamから送られたリクエストかどうかを確かめるための手段として、Webhookごとに固有のトークンが生成され、X-Qiita-Token というリクエストヘッダにこの値が含まれるようになりました。Webhookのリクエストを受け取る側でトークンの内容が正しいものか検証することで、リクエストの偽装を防ぐことができます。トークンはWebhookの管理画面から確認できます (Webhookはチームの管理者しか設定できないのでご注意ください)。

image

ドキュメント

http://qiita.com/api/webhook/docsで公開しているWebhookのドキュメントを改善し、Webhookで送られるHTTPリクエストに関する説明や、イベントごとに送られるオブジェクトの型情報などを追記しました。

image

データ

記事の変更理由やコメントの作成日時など、これまで存在しなかった幾つかのプロパティを追加しました。詳しくはドキュメントをご覧ください。

おわり

Qiita TeamのWebhookの変更についてお知らせしました。Qiita TeamではSlackやHipChatとの連携機能なども提供していますが、Webhookを利用すればより自由度の高い処理も実現できます。 http://requestb.in/などを利用すれば簡単に試すことができるので、これまでWebhookを使ったことの無かった方もぜひ試してみてください。