Перейти к содержимому

Обновление вебхука PUT ​

Обновите имя, шаблон сообщения, уровень по умолчанию, кнопки действий или статус активности вебхука. Поля, которые не переданы, сохранят текущие значения.

Эндпоинт ​

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

Аутентификация ​

Обязательно

Добавьте в запрос один из этих заголовков:

  • Token: <your-api-key> — получите его в разделе API-ключи
  • Authorization: Bearer <jwt-token> — из входа

Запрос ​

Параметры пути ​

ПараметрТипОбязательныйОписание
tidstring✅Уникальный идентификатор вебхука

Заголовки ​

ЗаголовокОбязательныйОписание
Token✅Ваш API-ключ
Authorization✅Bearer <jwt-token>

Параметры тела запроса ​

ПараметрТипОбязательныйОписание
namestring❌Новое имя
urlstring❌Новый слаг адреса для приёма https://p4a.me/wh/{url}. Старый адрес перестанет работать. Если слаг уже занят, вернётся 409
messagestring❌Новый шаблон сообщения
is_activeboolean❌Включить/выключить вебхук
application_idstring❌Новый TID приложения
device_idstring❌Новый TID устройства
default_levelstring | int | null❌Уровень важности по умолчанию для сообщений из этого вебхука, если в payload нет level: имя (silent…critical) или целое число (-2..2). null удаляет значение, и тогда действует уровень приложения
actionsstring❌JSON-шаблон кнопок действий с плейсхолдерами %field.path%, см. Создание вебхука. "" удаляет кнопки

Отключение вебхука

Вебхук с is_active: false по-прежнему принимает входящие запросы и отвечает 200, но оповещение не создаётся. Такие вызовы фиксируются в истории вебхука с 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

Вебхук успешно обновлён

json
{
  "data": "success"
}

Ответы с ошибками ​

СтатусОписание
400Bad Request — некорректный default_level или шаблон actions, либо пустые name или message
401Unauthorized — токен неверный или не передан
404Not Found — вебхук, приложение или устройство не существует
409Conflict — слаг url уже занят

Документация Pocket Alert