機能説明
登録済みWebhook通知先の一覧を返します。
リクエスト
エンドポイント
/v1/webhooks
HTTPメソッド
GET
リクエストボディ
なし
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| 認証失敗 | 401 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| data | Webhook型の配列 | 0:* | - |
Webhook
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| event | 文字列 | 1 | Webhookイベント |
| url | 文字列 | 1 | Webhookで通知するURL |
成功
{
"code": 200,
"data": [
{"event":"DELIVERED","url":"https://example.com"},
{"event":"BOUNCED","url":"https://example.com"}
]
}
失敗
{"code":404,"error":"resource not found"}