1. Webhookとは
blastengineではWebhookを用いて、配信したメールがエラーによって受信者へ送信できなかったときに、バウンスメールの情報を指定されたURL（サーバー）へHTTP POSTすることが可能です。このWebhookの機能を利用することで、外部システムに対してblastengine側を起点として情報連携が可能となります。
※ 現在はAPIを利用して配信されたメールのみ対象になり、SMTPには対応しておりません。
2. 通知できるイベントの種類
メールが届かなかった場合にイベントとして通知することが可能です。
| イベント タイプ | 発生ケース | 補足 |
|---|---|---|
| DROP | エラー停止リスト内のメールアドレスへの送信 | 配信リクエストの内容や、配信停止リクエストを確認してください。 |
| SOFTERROR | 宛先の問題などによる一次的なエラー | リトライにより一定時間経過後に到達する場合があります。 |
| HARDERROR | メールアドレスが存在しないなど恒久的なエラー | 当該アドレスの削除又は修正を実施してください。 |
※ トランザクションと一斉配信それぞれで設定が可能です。
3. 通知内容
各項目の説明
| 項目 | 説明 |
|---|---|
| type | 通知するイベントタイプ |
| datetime | バウンスメールを受信した時間（ISO 8601拡張形式） |
| detail | 通知内容の詳細 |
| mailaddress | エラーになったメールアドレス |
| subject | 配信したメールの件名 |
| error_code | 配信先からのレスポンスコード |
| error_message | エラーメッセージ（blastengine内で解析した文章） |
| delivery_id | 配信ID |
| insert_codes | 通知差し込みコード（未設定時は含まれません） |
| key | 管理画面で設定した差し込みの対象となるキー文字列 |
| value | 差し込みする値 |
通知される内容のサンプル
{
"events": [
{
"event": {
"type": "DROP",
"datetime": "YYYY-MM-DDTHH:mm:ss+09:00",
"detail": {
"mailaddress": "xxxx.xxxx@xxxxx.xxx",
"subject": "XXXXXXXXXXXXXX",
"error_code": "554(errors)",
"error_message": "エラー停止リストに含まれる宛先であるため、配信がドロップされました",
"delivery_id": XXXX,
"insert_codes": [
{
"key": "__XXXX__",
"value": "XXXXXXXX"
}
]
}
}
},
{
"event": {
"type": "HARDERROR",
"datetime": "YYYY-MM-DDTHH:mm:ss+09:00",
"detail": {
"mailaddress": "xxxx.xxxx@xxxxx.xxx",
"subject": "XXXXXXXXXXXXXX",
"error_code": "550",
"error_message": "宛先のメールアドレスがありません",
"delivery_id": XXXX,
"insert_codes": [
{
"key": "__XXXX__",
"value": "XXXXXXXX"
}
]
}
}
}
]
}
4. 管理画面での設定手順
① Webhookの設定画面を開く
- blastengineにログイン
- 画面右上の【歯車マーク（設定）】をクリック
- Webhook内の【確認・変更】をクリック
② Webhookの設定を変更
- モーダル内の【変更】をクリック
- 有効化にチェックを入れる
- 通知先のURLを記載する
- トランザクション、一斉配信それぞれで通知したいイベントにチェックを入れる
- 通知内容に含めたい差し込みコードを設定する
- 任意設定項目です
- 改行区切りで最大5つまで設定可能です
- リトライの有無を設定する
- 通知に失敗した場合、最大3回のリトライを実施します
- リトライは一定時間を開けて順次実施します
- リトライを有効にする場合、2重処理を起こす可能性があります。冪等性を考慮して実装してください。
- 【確認】をクリック
③ 設定の確定
内容を確認し、問題がなければ【変更】をクリック
