Webhook を更新 PUT
Webhook の名前、メッセージテンプレート、デフォルトレベル、アクションボタン、有効状態を更新します。省略したフィールドは現在の値のまま変わりません。
エンドポイント
PUT https://api.pocketalert.app/v1/webhooks/{tid}認証
必須
リクエストに次のいずれかのヘッダーを含めてください。
リクエスト
パスパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
tid | string | ✅ | Webhook の一意の識別子 |
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
Token | ✅ | API キー |
Authorization | ✅ | Bearer <jwt-token> |
ボディパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | ❌ | 新しい名前 |
url | string | ❌ | 受信 URL https://p4a.me/wh/{url} の新しいスラッグ。以前の URL は使えなくなります。既に使われているスラッグを指定すると 409 が返されます |
message | string | ❌ | 新しいメッセージテンプレート |
is_active | boolean | ❌ | Webhook を有効化/無効化します |
application_id | string | ❌ | 新しいアプリケーションの TID |
device_id | string | ❌ | 新しいデバイスの TID |
default_level | string | int | null | ❌ | ペイロードに level がない場合に、この Webhook からのメッセージに適用するデフォルトの優先度レベルです。名前(silent…critical)または整数(-2..2)を指定します。null を指定すると削除され、アプリケーションのレベルが適用されます |
actions | string | ❌ | %field.path% プレースホルダーを含む JSON アクションボタンテンプレートです。詳しくは Webhook を作成を参照してください。"" を指定するとボタンが削除されます |
Webhook を無効にする
is_active: false の Webhook も受信リクエストは受け付け、200 を返しますが、アラートは作成されません。これらの呼び出しは Webhook 履歴に error_code: inactive として記録されます。
リクエスト例
bash
curl -X PUT "https://api.pocketalert.app/v1/webhooks/kblf7mh9j8jjyeh4fx" \
-H "Token: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"name": "GitHub Push (Inactive)",
"is_active": false
}'javascript
const tid = 'kblf7mh9j8jjyeh4fx';
const response = await fetch(`https://api.pocketalert.app/v1/webhooks/${tid}`, {
method: 'PUT',
headers: {
'Token': 'your-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'GitHub Push (Inactive)',
is_active: false
})
});python
import requests
tid = 'kblf7mh9j8jjyeh4fx'
response = requests.put(
f'https://api.pocketalert.app/v1/webhooks/{tid}',
headers={'Token': 'your-api-key'},
json={'name': 'GitHub Push (Inactive)', 'is_active': False}
)
print(response.json())php
$tid = 'kblf7mh9j8jjyeh4fx';
$response = Http::withHeaders([
'Token' => 'your-api-key',
])->put('https://api.pocketalert.app/v1/webhooks/'.$tid, [
'name' => 'GitHub Push (Inactive)',
'is_active' => false,
]);
return $response->json();レスポンス
成功レスポンス
200 OK
Webhook の更新に成功しました
json
{
"data": "success"
}エラーレスポンス
| ステータス | 説明 |
|---|---|
400 | Bad Request — default_level または actions テンプレートが不正な場合、または name や message が空の場合 |
401 | Unauthorized — トークンが無効または未指定です |
404 | Not Found — Webhook、アプリケーション、またはデバイスが存在しません |
409 | Conflict — url のスラッグが既に使われています |