Aller au contenu

Mettre à jour un webhook PUT ​

Mettez à jour le nom, le modèle de message, le niveau par défaut, les boutons d’action ou l’état d’activité d’un webhook. Les champs omis conservent leur valeur actuelle.

Point de terminaison ​

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

Authentification ​

Obligatoire

Incluez l’un de ces en-têtes dans votre requête :

  • Token: <your-api-key> — Obtenez-la depuis Clés API
  • Authorization: Bearer <jwt-token> — Depuis Connexion

Requête ​

Paramètres de chemin ​

ParamètreTypeObligatoireDescription
tidstring✅Identifiant unique du webhook

En-têtes ​

En-têteObligatoireDescription
Token✅Votre clé API
Authorization✅Bearer <jwt-token>

Paramètres du corps ​

ParamètreTypeObligatoireDescription
namestring❌Nouveau nom
urlstring❌Nouveau slug de l’URL de réception https://p4a.me/wh/{url}. L’ancienne URL cesse de fonctionner. Un slug déjà utilisé renvoie 409
messagestring❌Nouveau modèle de message
is_activeboolean❌Activer/Désactiver le webhook
application_idstring❌Nouveau TID de l’application
device_idstring❌Nouveau TID de l’appareil
default_levelstring | int | null❌Niveau de priorité par défaut des messages de ce webhook lorsque la charge utile ne contient pas de level : un nom (silent…critical) ou un entier (-2..2). null le supprime, de sorte que le niveau de l’application s’applique
actionsstring❌Modèle JSON des boutons d’action avec des espaces réservés %field.path%, voir Créer un webhook. "" supprime les boutons

Désactiver un webhook

Un webhook avec is_active: false accepte toujours les requêtes entrantes et répond 200, mais aucune alerte n’est créée. Ces appels sont enregistrés dans Historique des webhooks avec error_code: inactive.

Exemple de requête ​

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

Réponse ​

Réponse de succès ​

200 OK

Webhook mis à jour avec succès

json
{
  "data": "success"
}

Réponses d’erreur ​

StatutDescription
400Requête incorrecte — un default_level ou un modèle actions invalide, ou un name ou message vide
401Non autorisé — Jeton invalide ou manquant
404Introuvable — Le webhook, l’application ou l’appareil n’existe pas
409Conflit — le slug url est déjà utilisé

Documentation de Pocket Alert