SendGrid Advent Calendar 2016 20日目

RequestBinを使ってSendGridのEvent Webhookを試してみる

3
いいね
0
コメント

2016年12月20日に投稿

技術的な記事を出すのは何気に初めてな@h_tky271です。

本記事は、 SendGrid Advent Calendar 2016 の20日目の記事です。

SendGridのEvent Webhookは、SendGrid経由で送信したメールで発生する様々なイベント（メールの送信、バウンス、開封、クリック、配信停止、迷惑メール報告など）をPOSTしてくれる機能です。この機能は、配信停止されたアドレスを自動でリストから削除したり、バウンスしたメールアドレスを自動で特定したりする際に重宝しますが、イベントデータを受信するには別途Webアプリケーションを用意する必要があります。

今回は「Event Webhookを簡単に試してみたい」「受け取るシステムを作るには少々時間がかかるので中々手を付けられない...」といった方向けに、RequestBinを使ってSendGridのEvent Webhookを簡単に試す方法をご紹介いたします。

RequestBinとは？
- Runscope社が提供するオープンソースのサービス

はじめに

RequestBinを利用する方法は2種類あります。

サービス提供されているRequestBinを利用する
- こちらの使い方は、SendGridの公式ドキュメントで公開されています
HerokuにオープンソースのRequestBinをデプロイして利用する

今回は、後者の「HerokuにオープンソースのRequestBinをデプロイして利用する」方法をご紹介いたします。

前提条件

Herokuアカウント、Toolbelt（CLI）
SendGridアカウント

手順

１． Herokuのアプリケーションを作成

公開されているコードをローカルマシンにクローンします。

$ git clone git://github.com/Runscope/requestbin.git

リポジトリ内に移動してHerokuのアプリケーションを作成します。

$ cd requestbin
$ heroku create

セッションの保存先としてHerokuのアドオン「heroku-redis」を追加し、環境変数を設定します。

$ heroku addons:add heroku-redis
$ heroku config:set REALM=prod

２． RequestBinをHerokuにデプロイ

RequestBinをHerokuにデプロイします。

$ git push heroku master

アプリケーションを起動します。

$ heroku open

以下のページが表示されれば、OKです。

３． RequestBinでユニークエンドポイントURLを生成

「Create a RequestBin」ボタンをクリックしてRequestBinのエンドポイントURLを生成します。

生成されたRequestBinのユニークエンドポイントURLをコピーします。

４． Event WebhookのPOST先を設定

こちらからSendGridにログインします。

SendGridのSettings > Mail Settingsの「Event Notification」をON（ACTIVE）にし、「HTTP POST URL」に先ほどコピーしたRequestBinのエンドポイントURLを設定します。

５．イベントデータをPOST

今回は、INTEGRATION TESTING TOOLでテストイベントを発生させます。

「Test Your integration」ボタンをクリックします。

POSTが完了すると、RAW BODYにイベントデータが表示されます。

イベントデータを整形すると以下のようになります。

[
  {
    "email":"example@test.com",
    "timestamp":1481600533,
    "smtp-id":"\u003c14c5d75ce93.dfd.64b469@ismtpd-555\u003e",
    "event":"processed",
    "category":"cat facts",
    "sg_event_id":"-3kmYSsKh_5mFRAT80LIPA==",
    "sg_message_id":"14c5d75ce93.dfd.64b469.filter0001.16648.5515E0B88.0"
  },
  {
    "email":"example@test.com",
    "timestamp":1481600533,
    "smtp-id":"\u003c14c5d75ce93.dfd.64b469@ismtpd-555\u003e",
    "event":"deferred",
    "category":"cat facts",
    "sg_event_id":"qda6PC4Ka9i4AfwxlOIzhw==",
    "sg_message_id":"14c5d75ce93.dfd.64b469.filter0001.16648.5515E0B88.0",
    "response":"400 try again later",
    "attempt":"5"
  }
]

もし、今後もイベントデータをPOSTしたい方は、Event Webhookの設定を保存してください。全てのイベント通知がHerokuにデプロイしたRequestBinのアプリケーションにPOSTされるようになります。

さいごに

いかがでしたでしょうか。RequestBinは、SendGridが提供している「EventKit-Rails」のようにPOSTしたイベントデータを様々な条件で検索したり、検索結果をダウンロードしたりすることはできませんが、「ほんのちょっとだけEvent Webookを使ってみたい」というときに重宝するアプリケーションです。ご興味のある方は、是非お試しください！

なお、Event Webhookを試す方法は他にもありますので、ご興味のある方はSendGridの公式ドキュメント、ブログもご覧ください。

技術的な記事を出すのは何気に初めてな[@h_tky271](https://twitter.com/h_tky271)です。

本記事は、 [SendGrid Advent Calendar 2016](http://qiita.com/advent-calendar/2016/sendgrid) の20日目の記事です。

[SendGrid](https://sendgrid.kke.co.jp/)の[Event Webhook](https://sendgrid.kke.co.jp/docs/API_Reference/Webhooks/event.html)は、SendGrid経由で送信したメールで発生する様々なイベント（メールの送信、バウンス、開封、クリック、配信停止、迷惑メール報告など）をPOSTしてくれる機能です。この機能は、配信停止されたアドレスを自動でリストから削除したり、バウンスしたメールアドレスを自動で特定したりする際に重宝しますが、イベントデータを受信するには別途Webアプリケーションを用意する必要があります。

今回は「Event Webhookを簡単に試してみたい」「受け取るシステムを作るには少々時間がかかるので中々手を付けられない...」といった方向けに、[RequestBin](http://requestb.in/)を使ってSendGridのEvent Webhookを簡単に試す方法をご紹介いたします。

* RequestBinとは？
    * [Runscope](https://www.runscope.com/)社が提供するオープンソースのサービス

# はじめに

RequestBinを利用する方法は2種類あります。

1. サービス提供されている[RequestBin](http://requestb.in/)を利用する
    * こちらの使い方は、SendGridの[公式ドキュメント](https://sendgrid.kke.co.jp/docs/API_Reference/Webhooks/debug.html)で公開されています
2. [Heroku](https://www.heroku.com/)にオープンソースの[RequestBin](https://github.com/Runscope/requestbin)をデプロイして利用する

今回は、後者の「HerokuにオープンソースのRequestBinをデプロイして利用する」方法をご紹介いたします。

# 前提条件

* [Heroku](https://www.heroku.com/)アカウント、[Toolbelt（CLI）](https://devcenter.heroku.com/articles/heroku-cli)
* [SendGrid](https://sendgrid.kke.co.jp/)アカウント

# 手順

## １． Herokuのアプリケーションを作成

[公開](https://github.com/Runscope/requestbin#deploy-your-own-instance-using-heroku)されているコードをローカルマシンにクローンします。

```zsh:
$ git clone git://github.com/Runscope/requestbin.git
```

リポジトリ内に移動してHerokuのアプリケーションを作成します。

```zsh:
$ cd requestbin
$ heroku create
```

セッションの保存先としてHerokuのアドオン「heroku-redis」を追加し、環境変数を設定します。

```zsh:
$ heroku addons:add heroku-redis
$ heroku config:set REALM=prod
```

## ２． RequestBinをHerokuにデプロイ

RequestBinをHerokuにデプロイします。

```zsh:
$ git push heroku master
```

アプリケーションを起動します。

```zsh:
$ heroku open
```

以下のページが表示されれば、OKです。

![RequestBin_Service.png](https://qiita-image-store.s3.amazonaws.com/0/106443/92a3bb89-22cd-e975-49b7-e3cb64585a4e.png)

## ３． RequestBinでユニークエンドポイントURLを生成

「Create a RequestBin」ボタンをクリックしてRequestBinのエンドポイントURLを生成します。

![RequestBin.png](https://qiita-image-store.s3.amazonaws.com/0/106443/62355c61-0f65-0309-c539-fd5cb9eb42e9.png)

生成されたRequestBinのユニークエンドポイントURLをコピーします。

![RequestBinURL.png](https://qiita-image-store.s3.amazonaws.com/0/106443/c3df0526-1cb3-b4db-0a64-70e9170db64c.png)

## ４． Event WebhookのPOST先を設定

[こちら](https://sendgrid.com/login)からSendGridにログインします。

SendGridのSettings > Mail Settingsの「Event Notification」をON（ACTIVE）にし、「HTTP POST URL」に先ほどコピーしたRequestBinのエンドポイントURLを設定します。

![SendGrid_EventWebook2.png](https://qiita-image-store.s3.amazonaws.com/0/106443/937f948d-192a-1645-e8a5-af1f95ee0f70.png)

## ５． イベントデータをPOST

今回は、INTEGRATION TESTING TOOLでテストイベントを発生させます。

「Test Your integration」ボタンをクリックします。
![SendGrid_EventWebook2.png](https://qiita-image-store.s3.amazonaws.com/0/106443/10a8c438-9214-10fa-76d4-dc514e3143a4.png)

POSTが完了すると、RAW BODYにイベントデータが表示されます。

![RequestBin_Result.png](https://qiita-image-store.s3.amazonaws.com/0/106443/d06ad864-3e34-7711-2d7b-47b7c596912a.png)

イベントデータを整形すると以下のようになります。

```json:
[
  {
    "email":"example@test.com",
    "timestamp":1481600533,
    "smtp-id":"\u003c14c5d75ce93.dfd.64b469@ismtpd-555\u003e",
    "event":"processed",
    "category":"cat facts",
    "sg_event_id":"-3kmYSsKh_5mFRAT80LIPA==",
    "sg_message_id":"14c5d75ce93.dfd.64b469.filter0001.16648.5515E0B88.0"
  },
  {
    "email":"example@test.com",
    "timestamp":1481600533,
    "smtp-id":"\u003c14c5d75ce93.dfd.64b469@ismtpd-555\u003e",
    "event":"deferred",
    "category":"cat facts",
    "sg_event_id":"qda6PC4Ka9i4AfwxlOIzhw==",
    "sg_message_id":"14c5d75ce93.dfd.64b469.filter0001.16648.5515E0B88.0",
    "response":"400 try again later",
    "attempt":"5"
  }
]
```

# さいごに

なお、Event Webhookを試す方法は他にもありますので、ご興味のある方はSendGridの公式[ドキュメント](https://sendgrid.kke.co.jp/docs/)、[ブログ](https://sendgrid.kke.co.jp/blog/)もご覧ください。

h_tky

3Contribution