コンテンツへスキップ

Webhook を取得 GET ​

一意の識別子を指定して、特定の Webhook の詳細を取得します。

エンドポイント ​

GET https://api.pocketalert.app/v1/webhooks/{tid}

認証 ​

必須

リクエストに次のいずれかのヘッダーを含めてください:

  • Token: <your-api-key> — API キーから取得できます
  • Authorization: Bearer <jwt-token> — ログインから取得できます

リクエスト ​

パスパラメーター ​

パラメーター型必須説明
tidstring✅Webhook の一意の識別子

ヘッダー ​

ヘッダー必須説明
Token✅API キー
Authorization✅Bearer <jwt-token>

リクエストの例 ​

bash
curl -X GET "https://api.pocketalert.app/v1/webhooks/kblf7mh9j8jjyeh4fx" \
  -H "Token: your-api-key"
javascript
const tid = 'kblf7mh9j8jjyeh4fx';
const response = await fetch(`https://api.pocketalert.app/v1/webhooks/${tid}`, {
  headers: { 'Token': 'your-api-key' }
});
const webhook = await response.json();
python
import requests

tid = 'kblf7mh9j8jjyeh4fx'
response = requests.get(
    f'https://api.pocketalert.app/v1/webhooks/{tid}',
    headers={'Token': 'your-api-key'}
)
print(response.json())
php
$tid = 'kblf7mh9j8jjyeh4fx';
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/webhooks/'.$tid);

return $response->json();

レスポンス ​

成功時のレスポンス ​

200 OK

Webhook オブジェクトを返します

フィールド型説明
tidstringWebhook の一意の識別子
namestringWebhook の名前
urlstringWebhook の URL スラッグ
messagestringメッセージテンプレート
is_activebooleanWebhook が有効かどうか
created_atstring作成日時
json
{
  "tid": "kblf7mh9j8jjyeh4fx",
  "name": "GitHub Push",
  "url": "cs994rqfkk8ljngt",
  "message": "Push to %repository.name%: %head_commit.message%",
  "is_active": true,
  "created_at": "01.09.2023 22:38:48"
}

エラーレスポンス ​

ステータス説明
401認証されていません — トークンが無効または未指定です
404見つかりません — Webhook が存在しません

Pocket Alert ドキュメント