Vai al contenuto

Aggiornare un webhook PUT ​

Aggiorna il nome, il template del messaggio, il livello predefinito, i pulsanti di azione o lo stato di attività di un webhook. I campi omessi mantengono il valore attuale.

Endpoint ​

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

Autenticazione ​

Obbligatorio

Includi uno di questi header nella richiesta:

  • Token: <your-api-key> — Ottienila da Chiavi API
  • Authorization: Bearer <jwt-token> — Da Accedi

Richiesta ​

Parametri del percorso ​

ParametroTipoObbligatorioDescrizione
tidstring✅Identificatore univoco del webhook
HeaderObbligatorioDescrizione
Token✅La tua chiave API
Authorization✅Bearer <jwt-token>

Parametri del body ​

ParametroTipoObbligatorioDescrizione
namestring❌Nuovo nome
urlstring❌Nuovo slug dell'URL di ricezione https://p4a.me/wh/{url}. Il vecchio URL smette di funzionare. Uno slug già in uso restituisce 409
messagestring❌Nuovo template del messaggio
is_activeboolean❌Abilita/Disabilita il webhook
application_idstring❌Nuovo TID dell'applicazione
device_idstring❌Nuovo TID del dispositivo
default_levelstring | int | null❌Livello di priorità predefinito per i messaggi di questo webhook quando il payload non contiene level: un nome (silent…critical) oppure un intero (-2..2). null lo rimuove, quindi si applica il livello dell'applicazione
actionsstring❌Template JSON dei pulsanti di azione con i segnaposto %field.path%, vedi Crea webhook. "" rimuove i pulsanti

Disabilitare un webhook

Un webhook con is_active: false continua ad accettare le richieste in arrivo e risponde con 200, ma non viene creato alcun avviso. Queste chiamate vengono registrate nella Cronologia webhook con error_code: inactive.

Esempio di richiesta ​

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

Risposta ​

Risposta di successo ​

200 OK

Webhook aggiornato con successo

json
{
  "data": "success"
}

Risposte di errore ​

StatoDescrizione
400Bad Request — un default_level o un template actions non valido, oppure un name o un message vuoto
401Unauthorized — token non valido o mancante
404Not Found — webhook, applicazione o dispositivo non esistente
409Conflict — lo slug url è già in uso

Documentazione di Pocket Alert