Langsung ke konten

Create Webhook POST ​

Buat webhook baru untuk menerima notifikasi dari layanan eksternal.

Endpoint ​

POST https://api.pocketalert.app/v1/webhooks

Autentikasi ​

Wajib

Sertakan salah satu header berikut dalam permintaan Anda:

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

Permintaan ​

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

Parameter Body ​

ParameterTipeWajibDeskripsi
namestring✅Nama webhook (misalnya "Sentry", "GitHub")
urlstring❌Slug dari URL penerima https://p4a.me/wh/{url}. Slug acak 20 karakter dibuat jika tidak disertakan. Harus unik: slug yang sudah dipakai mengembalikan 409
messagestring✅Templat pesan (gunakan * untuk JSON mentah)
application_idstring❌TID aplikasi untuk mengelompokkan pesan
device_idstring❌TID perangkat tujuan (hilangkan untuk semua perangkat)
default_levelstring | int❌Level prioritas default yang diterapkan pada pesan dari webhook ini jika payload tidak menentukannya: nama (silent, low, default, high, critical) atau int (-2..2). Lihat Level prioritas pesan.
actionsstring❌Templat JSON tombol aksi. Bentuknya sama dengan tindakan pesan, tetapi label/value boleh berisi placeholder %field.path% yang diisi dari payload masuk. Disimpan sebagai string JSON. Fitur berbayar: dihapus pada paket gratis.

Templat Tombol Aksi ​

actions memungkinkan notifikasi yang dibuat webhook memuat hingga 3 tombol, dengan placeholder %field.path% yang digantikan dari payload masuk (sintaks sama dengan templat pesan):

json
[
  { "type": "view", "label": "Open issue", "value": "%issue.html_url%" },
  { "type": "http", "label": "Ack", "value": "{\"url\":\"https://ops.example.com/ack/%issue.id%\",\"method\":\"POST\"}" }
]

Templat diperiksa saat Anda menyimpannya: harus berupa array JSON berisi paling banyak 3 tombol dengan type yang valid, dan tombol tanpa placeholder harus sepenuhnya valid, jika tidak permintaan mengembalikan 400.

Setelah penggantian, setiap tombol divalidasi seperti tindakan pesan. Tombol yang tidak valid untuk payload ini, misalnya tombol view yang field URL-nya tidak ada, dihapus secara terpisah; tombol lain dan pesannya tetap dikirim.

Tombol aksi adalah fitur berbayar. Pada paket gratis, tombol tersebut dihapus di sisi server dan pesan dikirim tanpa tombol.

Sintaks Templat Pesan ​

Gunakan %field.path% untuk mengambil nilai dari JSON masuk:

TemplatDeskripsi
*Menampilkan seluruh payload JSON
%field%Mengambil field level atas
%object.field%Mengambil field bertingkat
%array.0.field%Mengambil dari array berdasarkan indeks
%%Karakter % literal. Hanya diperlukan tepat sebelum kata yang diikuti % lain, seperti %cpu%%%; % yang diikuti spasi, seperti 90% on %host%, tetap apa adanya

Lihat Pengaturan Webhook untuk contoh detail.

Contoh Permintaan ​

bash
curl -X POST "https://api.pocketalert.app/v1/webhooks" \
  -H "Token: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "GitHub Push",
    "message": "Push to %repository.name%: %head_commit.message%",
    "application_id": "s9h1ekk5xb46jikthl"
  }'
javascript
const response = await fetch('https://api.pocketalert.app/v1/webhooks', {
  method: 'POST',
  headers: {
    'Token': 'your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'GitHub Push',
    message: 'Push to %repository.name%: %head_commit.message%',
    application_id: 's9h1ekk5xb46jikthl'
  })
});

const webhook = await response.json();
console.log('Webhook URL:', `https://p4a.me/wh/${webhook.url}`);
python
import requests

response = requests.post(
    'https://api.pocketalert.app/v1/webhooks',
    headers={'Token': 'your-api-key'},
    json={
        'name': 'GitHub Push',
        'message': 'Push to %repository.name%: %head_commit.message%',
        'application_id': 's9h1ekk5xb46jikthl'
    }
)

webhook = response.json()
print(f"Webhook URL: https://p4a.me/wh/{webhook['url']}")
php
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->post('https://api.pocketalert.app/v1/webhooks', [
    'name' => 'GitHub Push',
    'message' => 'Push to %repository.name%: %head_commit.message%',
    'application_id' => 's9h1ekk5xb46jikthl',
]);

$webhook = $response->json();
echo 'Webhook URL: https://p4a.me/wh/'.$webhook['url'];

Respons ​

Respons Sukses ​

201 Created

Webhook berhasil dibuat

FieldTipeDeskripsi
tidstringPengenal unik webhook
namestringNama webhook
urlstringSlug URL webhook — gunakan ini di layanan eksternal
messagestringTemplat pesan
actionsstringTemplat JSON tombol aksi (kosong jika tidak diatur)
is_activebooleanApakah webhook aktif
json
{
  "tid": "kblf7mh9j8jjyeh4fx",
  "name": "GitHub Push",
  "url": "cs994rqfkk8ljngt",
  "message": "Push to %repository.name%: %head_commit.message%",
  "actions": "",
  "application_tid": "qm47b9pzxzx7applfd0",
  "device_tid": "",
  "is_active": true,
  "created_at": "01.09.2023 22:38:48"
}

Menggunakan Webhook Anda

Atur layanan eksternal Anda untuk melakukan POST ke:

https://p4a.me/wh/{url}

Respons Error ​

StatusDeskripsi
400Bad Request — name atau message tidak ada, default_level tidak valid, atau templat actions tidak valid
401Unauthorized — Token tidak valid atau tidak ada
403Forbidden — batas webhook pada paket Anda sudah tercapai
404Not Found — application_id atau device_id tidak ada
409Conflict — slug url sudah dipakai

Dokumentasi Pocket Alert