Webhook通知先登録

イベントに該当するWebhookの通知先を登録する。

イベントの通知先が登録済みの場合はエラーとなる。

リクエスト

エンドポイント

/v1/webhooks

HTTPメソッド

POST もしくは PUT

リクエストボディ

JSON形式であること

素名	型	要素数	制限	説明
event	文字列の配列	1	配列内の各要素は半角英語、以下のいずれかのみ DELIVERED メールを送信したイベント PROCESSED メールの文面を生成したイベント BOUNCED メールがバウンスとなったイベント DROPPED 配信停止アドレスに登録された宛先に対し、メールを送信せずに破棄したイベント SPAM_REPORT 送信したメールがスパムメールであると判定されたイベント OPENED トラッキング情報（ビーコン）を付加したメールが開封されたと判定されたイベント CLICKED トラッキング情報を付加したメール中のリンクがクリックされたと判定されたイベント BLACKLISTED ブラックリスト登録された宛先に対し、メールを送信せずに破棄したイベント RELAYED SMTPリレー経由でメールを受け取り、キューイングされたイベント	Webhookイベント
url	文字列	1	半角英数字記号最大1024文字 URL文字列であること、 https:// で始まること ※ ポート指定は許容しない	Webhookで通知するURL

リクエストボディサンプル

{
"event": ["DELIVERED","PROCESSED","BOUNCED","SPAM_REPORT","DROPPED"],
"url": "https://example.com"
}

レスポンス

ステータスコード

状態	コード
成功	201
リクエストボディがjsonではない	400
jsonリクエストのバリデーションエラー	400
認証失敗	401
既に登録されている等の理由で登録に失敗した	403
存在しないエンドポイント	404
許可されていないHTTPメソッド	405
システムエラーが発生した	500
システムが一時的にサービスを提供できない状態になっている	503
システムのタイムアウト	504

レスポンスボディ

要素名	型	要素数	説明
code	数値	1	ステータスコード
data	Webhook型の配列	0:*

Webhook

要素名	型	要素数	説明
event	文字列	1	イベント
url	文字列	1	Webhookで通知するURL

成功

{
"code":201,
"data":[
{"event":"DELIVERED","url":"https://example.com"},
{"event":"PROCESSED","url":"https://example.com"},
{"event":"BOUNCED","url":"https://example.com"},
{"event":"SPAM_REPORT","url":"https://example.com"},
{"event":"DROPPED","url":"https://example.com"}
]
}

失敗

{"code":400,"validation_errors":{"event":{"event":["PROCESSED is duplicated"]}},}

{"code":400,"validation_errors":{"event":"must be PROCESSED,DELIVERED,BOUNCED,DROPPED,SPAM_REPORT,OPENED,CLICKED,BLACKLISTED,RELAYED"}}