Webhook管理

機能の概要

設定したイベントが発生した際に、指定したエンドポイントへ向けてHTTPリクエスト（POSTメソッド）で発生したイベント内容を通知するWebhookを作成する機能です。

操作説明

Webhookを作成する

サイドメニューの「Webhook管理」をクリックします。
「Webhook作成」ボタンをクリックします。
「URL（エンドポイント）」を入力し、「イベント」を選択します。
入力した情報が正しいことを確認し、「確認」ボタンをクリックします。
最後に、「送信」ボタンをクリックすることで完了です。
※保存した「Webhook」は編集することができないためご注意ください。

Webhookを削除する

サイドメニューの「Webhook管理」をクリックします。
削除するWebhookの「削除（ゴミ箱マーク）」をクリックします。
削除対象のWebhook（URL）が誤りでないことを確認し、「削除する」にチェックを入れます。
最後に「削除」ボタンをクリックすることで完了です。

署名キーを取得する

サイドメニューの「Webhook管理」をクリックします。
「署名キー取得」ボタンをクリックします。
「署名キーをクリップボードにコピー」ボタンをクリックします。
最後に「戻る」ボタンをクリックすることで完了です。

イベント一覧

イベント名	対応配信	詳細
文面生成	API	APIが受け取ったメールリクエストを元に、メール文面を生成した時点で発生するイベント
送信成功	API SMTPリレー	外部サーバがメールを受け付けた際に発生するイベント
バウンス	API SMTPリレー	外部サーバがメール送信時に500系のエラーを返してきた際、もしくは一旦外部サーバがメールを受け付けた後にバウンスメールを送信してきた際に発生するイベント
配信停止	API SMTPリレー	配信停止アドレス宛へのメール送信を試みた際に発生するイベント ※文面生成/SMTPリレー/ブラックリストイベントとは重複しない
スパム	API SMTPリレー	外部サーバが、メール送信時にスパム判定として拒否応答を返してきた際、もしくは一旦外部サーバがメールを受け付けた後にスパムとして判定した旨が記載されたバウンスメールを送信してきた際に発生するイベント ※バウンスの特殊なケースとして見なしており、バウンスイベントとは重複しない
メール開封	API	トラッキング情報を付与したメールが開封された際に発生するイベント
URLクリック	API	トラッキング情報を付与したメールのリンクがクリックされた際に発生するイベント
ブラックリスト	API SMTPリレー	ブラックリストに登録されたアドレス宛へメール送信を試みた際に発生するイベント ※文面生成/SMTPリレー/配信停止イベントとは重複しない
SMTPリレー	SMTPリレー	SMTPリレーで受け取ったメールを元に、メール文面を生成した時点で発生するイベント

入力項目の制限

URL（必須項目）

制約
- 半角英数字および記号
- 1024文字以下
- URL形式であること
  - https://で始まること

イベント（必須項目）

制約
- いずれかが選択されていること
  - 送信成功
  - 文面生成
  - バウンス
  - 配信停止
  - スパム
  - メール開封
  - URLクリック
  - ブラックリスト
  - SMTPリレー

その他

Webhook通知先上限
- 制約
  - 1件のみ