Saltar al contenido

Actualizar webhook PUT ​

Actualiza el nombre, la plantilla del mensaje, el nivel predeterminado, los botones de acción o el estado de actividad de un webhook. Los campos omitidos conservan su valor actual.

Endpoint ​

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

Autenticación ​

Obligatorio

Incluye uno de estos encabezados en tu solicitud:

Solicitud ​

Parámetros de ruta ​

ParámetroTipoObligatorioDescripción
tidstring✅Identificador único del webhook

Encabezados ​

EncabezadoObligatorioDescripción
Token✅Tu clave de API
Authorization✅Bearer <jwt-token>

Parámetros del cuerpo ​

ParámetroTipoObligatorioDescripción
namestring❌Nuevo nombre
urlstring❌Nuevo slug de la URL de recepción https://p4a.me/wh/{url}. La URL anterior deja de funcionar. Si el slug ya está en uso, devuelve 409
messagestring❌Nueva plantilla del mensaje
is_activeboolean❌Activa o desactiva el webhook
application_idstring❌Nuevo TID de aplicación
device_idstring❌Nuevo TID de dispositivo
default_levelstring | int | null❌Nivel de prioridad predeterminado para los mensajes de este webhook cuando el payload no incluye level: un nombre (silent…critical) o un entero (-2..2). null lo elimina, de modo que se aplica el nivel de la aplicación
actionsstring❌Plantilla JSON de botones de acción con marcadores %field.path%, consulta Crear webhook. "" elimina los botones

Desactivar un webhook

Un webhook con is_active: false sigue aceptando solicitudes entrantes y responde 200, pero no se crea ninguna alerta. Estas llamadas se registran en el Historial de webhooks con error_code: inactive.

Ejemplo de solicitud ​

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

Respuesta ​

Respuesta correcta ​

200 OK

Webhook actualizado correctamente

json
{
  "data": "success"
}

Respuestas de error ​

EstadoDescripción
400Solicitud incorrecta — un default_level o una plantilla actions no válidos, o un name o message vacío
401No autorizado — token no válido o ausente
404No encontrado — el webhook, la aplicación o el dispositivo no existe
409Conflicto — el slug de url ya está en uso

Documentación de Pocket Alert