インバウンド受信通知Webhook登録

インバウンド受信用のWebhookの通知先を登録する。

ドメインに対応する通知先が登録済みの場合はエラーとなる。

リクエスト

エンドポイント

/v1/inbounds/webhooks

HTTPメソッド

POST もしくは PUT

リクエストボディ

JSON形式であること

要素名	型	要素数	制限	説明
domain	文字列	1	半角英数字 . - 最大253文字ドメイン形式の文字列であること	ドメイン
url	文字列	1	半角英数字記号最大1024文字 URL文字列であること、 https:// で始まること ※ ポート指定は許容しない	Webhookで通知するURL

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

{
"domain": "example.com",
"url": "https://example.net",
}

レスポンス

ステータスコード

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

レスポンスボディ

要素名	型	要素数	説明
code	数値	1	ステータスコード
domain	文字列	1	登録したドメイン
type	文字列	1	INBOUND 固定
status	文字列	1	VALIDATED 固定

成功

{"code":201,"domain":"example.com","url":"https://example.net"}

失敗

{"code":400,"error":"validation error", "validation_errors":{"domain":"required"}}

{"code":403,"data_error":{"domain":"example.com not exists"}}

インバウンド受信通知設定の登録

インバウンド受信通知を利用するためには、以下の手順を実行する。

1. インバウンド受信ドメイン登録APIの実行
curl -XPOST -H 'Authorization:bearer APIトークン' 'https://api.autobahn.email/v1/domains/inbounds' -d '{"domain":ドメイン}'

2. インバウンド受信通知Webhook登録APIの実行
curl -XPOST -H 'Authorization:bearer APIトークン' 'https://api.autobahn.email/v1/inbounds/webhooks' -d '{"domain":ドメイン, "url":通知先URL}'

3. MXレコードの登録