Webhook 履歴 GET
特定の Webhook に届いたリクエストの履歴を取得します。送信された内容、レンダリング結果、プッシュ通知が配信されたかどうかを確認できます。
エンドポイント
GET https://api.pocketalert.app/v1/webhooks/{tid}/history認証
必須
リクエストに以下のいずれかのヘッダーを含めてください:
リクエスト
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
tid | string | ✅ | Webhook の一意の識別子 |
クエリパラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
page | integer | 1 | ページ番号 |
per | integer | 50 | 1 ページあたりの件数(最大 200) |
status | string | — | 結果で絞り込み: success または error |
リクエストの例
bash
curl -X GET "https://api.pocketalert.app/v1/webhooks/kblf7mh9j8jjyeh4fx/history?per=25&status=error" \
-H "Token: your-api-key"javascript
const tid = 'kblf7mh9j8jjyeh4fx';
const response = await fetch(`https://api.pocketalert.app/v1/webhooks/${tid}/history?per=25`, {
headers: { 'Token': 'your-api-key' }
});
const history = await response.json();python
import requests
tid = 'kblf7mh9j8jjyeh4fx'
response = requests.get(
f'https://api.pocketalert.app/v1/webhooks/{tid}/history',
headers={'Token': 'your-api-key'},
params={'per': 25, 'status': 'error'}
)
print(response.json())レスポンス
成功時のレスポンス
200 OK
リクエストをページ分割した一覧を返します。新しいものが先頭に来ます
| フィールド | 型 | 説明 |
|---|---|---|
requests | array | 記録されたリクエスト |
total | integer | 保存期間内のリクエストの総数 |
page | integer | 現在のページ |
per | integer | 1 ページあたりの件数 |
retention_days | integer | お使いのプランで履歴を保持する日数(0 = 無制限) |
webhook | object | tid、name、url、is_active |
requests の各項目:
| フィールド | 型 | 説明 |
|---|---|---|
id | integer | リクエストの識別子 |
method | string | 送信元が使用した HTTP メソッド |
source_ip | string | 呼び出し元の IP アドレス |
content_type | string | リクエストのコンテンツタイプ |
query | string | 生のクエリ文字列 |
headers | object | リクエストヘッダー(機密性の高いものは伏せ字になります) |
body | string | リクエストのペイロード |
size | integer | ペイロードのサイズ(バイト) |
status | string | success または error |
error_code | string | 失敗の理由。成功時は空です |
rendered_message | string | テンプレートから生成されたメッセージ |
message_tid | string | 作成されたメッセージの識別子。失敗時は空です |
priority | integer | 決定されたアラートレベル |
duration_ms | integer | 処理時間 |
created_at | string | リクエストを受信した日時 |
json
{
"requests": [
{
"id": 412,
"method": "POST",
"source_ip": "140.82.115.16",
"content_type": "application/json",
"query": "",
"headers": { "User-Agent": "GitHub-Hookshot", "Authorization": "[redacted]" },
"body": "{\"repository\":{\"name\":\"pocketalert\"}}",
"size": 38,
"status": "success",
"error_code": "",
"rendered_message": "Push to pocketalert",
"message_tid": "yrst1db64dbbe7euurpmanhdy",
"priority": 1,
"duration_ms": 24,
"created_at": "18.07.2026 16:45:06"
}
],
"total": 1,
"page": 1,
"per": 50,
"retention_days": 90,
"webhook": {
"tid": "kblf7mh9j8jjyeh4fx",
"name": "GitHub Push",
"url": "cs994rqfkk8ljngt",
"is_active": true
}
}エラーコード
status が error の場合、error_code で原因を確認できます:
| コード | 意味 |
|---|---|
inactive | Webhook が無効になっているため、通知は送信されませんでした |
invalid_json | ペイロードを JSON として解析できませんでした |
empty_message | テンプレートが空の文字列になりました。通常はペイロードに存在しない %path% が原因です |
encryption_failed | メッセージを暗号化できませんでした |
save_failed | メッセージを保存できませんでした |
daily_limit | アカウントの1 日のメッセージ上限に達しました。呼び出しは 429 を受け取り、通知は送信されませんでした。ペイロードとレンダリング結果はここに保持されます |
エラーレスポンス
| ステータス | 説明 |
|---|---|
401 | 認証されていません — トークンが無効または未指定です |
404 | 見つかりません — Webhook が存在しません |
注意事項
保持期間
履歴は、お使いのプランに応じた日数の間保持されます(retention_days を参照)。無料プランは 7 日、Starter は 30 日、Medium は 90 日、Large は 365 日です。保持期間を過ぎたリクエストは自動的に削除されます。また、1 つの Webhook の記録が 1,000 件を超えると、古いものから自動的に削除されます。
プライバシー
ペイロードは、メッセージの内容と同じように、お客様専用のキーで保存時に暗号化されます。Authorization、Cookie、API キーのヘッダーは、保存前に [redacted] に置き換えられます。