Zum Inhalt springen

Webhook aktualisieren PUT ​

Aktualisiere den Namen, die Nachrichtenvorlage, die Standardpriorität, die Aktionsbuttons oder den Aktivitätsstatus eines Webhooks. Nicht angegebene Felder behalten ihren aktuellen Wert.

Endpunkt ​

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

Authentifizierung ​

Erforderlich

Füge einen dieser Header in deiner Anfrage hinzu:

Anfrage ​

Pfadparameter ​

ParameterTypErforderlichBeschreibung
tidstring✅Eindeutige ID des Webhooks
HeaderErforderlichBeschreibung
Token✅Dein API-Schlüssel
Authorization✅Bearer <jwt-token>

Body-Parameter ​

ParameterTypErforderlichBeschreibung
namestring❌Neuer Name
urlstring❌Neuer Slug der Empfangs-URL https://p4a.me/wh/{url}. Die alte URL funktioniert nicht mehr. Ein bereits vergebener Slug liefert 409
messagestring❌Neue Nachrichtenvorlage
is_activeboolean❌Webhook aktivieren/deaktivieren
application_idstring❌Neue TID der Anwendung
device_idstring❌Neue TID des Geräts
default_levelstring | int | null❌Standardpriorität für Nachrichten dieses Webhooks, wenn die Payload kein level enthält: ein Name (silent…critical) oder ein Int (-2..2). null entfernt sie, sodass die Priorität der Anwendung gilt
actionsstring❌JSON-Vorlage für Aktionsbuttons mit %field.path%-Platzhaltern, siehe Webhook erstellen. "" entfernt die Buttons

Webhook deaktivieren

Ein Webhook mit is_active: false nimmt weiterhin eingehende Anfragen entgegen und antwortet mit 200, es wird aber kein Alert erstellt. Diese Aufrufe werden im Webhook-Verlauf mit error_code: inactive protokolliert.

Beispielanfrage ​

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();

Antwort ​

Erfolgreiche Antwort ​

200 OK

Webhook erfolgreich aktualisiert

json
{
  "data": "success"
}

Fehlerantworten ​

StatusBeschreibung
400Bad Request — ungültige default_level- oder actions-Vorlage oder leerer name oder message
401Unauthorized — Token ungültig oder fehlt
404Not Found — Webhook, Anwendung oder Gerät existiert nicht
409Conflict — der url-Slug ist bereits vergeben

Pocket Alert Dokumentation