Langsung ke konten

Update Webhook PUT ​

Perbarui nama, templat pesan, level default, tombol aksi, atau status aktif webhook. Field yang tidak disertakan akan tetap menggunakan nilai saat ini.

Endpoint ​

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

Autentikasi ​

Required

Sertakan salah satu header berikut dalam permintaan Anda:

  • Token: <your-api-key> — Dapatkan dari Kunci API
  • Authorization: Bearer <jwt-token> — Dari Masuk

Permintaan ​

Path Parameters ​

ParameterTypeRequiredDescription
tidstring✅Pengenal unik webhook

Headers ​

HeaderRequiredDescription
Token✅Kunci API Anda
Authorization✅Bearer <jwt-token>

Body Parameters ​

ParameterTypeRequiredDescription
namestring❌Nama baru
urlstring❌Slug baru untuk URL penerima https://p4a.me/wh/{url}. URL lama tidak lagi berfungsi. Slug yang sudah dipakai akan mengembalikan 409
messagestring❌Templat pesan baru
is_activeboolean❌Aktifkan/nonaktifkan webhook
application_idstring❌TID aplikasi baru
device_idstring❌TID perangkat baru
default_levelstring | int | null❌Level prioritas default untuk pesan dari webhook ini ketika payload tidak memiliki level: nama (silent…critical) atau int (-2..2). null akan menghapusnya, sehingga level aplikasi yang berlaku
actionsstring❌Templat JSON tombol aksi dengan placeholder %field.path%, lihat Create Webhook. "" menghapus tombol

Disabling a webhook

Webhook dengan is_active: false tetap menerima permintaan masuk dan merespons 200, tetapi tidak ada alert yang dibuat. Panggilan tersebut dicatat di Riwayat Webhook dengan error_code: inactive.

Contoh Permintaan ​

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

Respons ​

Respons Sukses ​

200 OK

Webhook berhasil diperbarui

json
{
  "data": "success"
}

Respons Error ​

StatusDescription
400Bad Request — default_level atau templat actions tidak valid, atau name atau message kosong
401Unauthorized — Token tidak valid atau tidak ada
404Not Found — Webhook, aplikasi, atau perangkat tidak ada
409Conflict — slug url sudah digunakan

Dokumentasi Pocket Alert