Langsung ke konten

Pengaturan Webhook ​

Pelajari cara mengonfigurasi template pesan webhook untuk mengekstrak data dari payload JSON yang masuk.

Sintaks Template Pesan ​

Saat membuat webhook, Anda mendefinisikan template pesan yang menentukan bagaimana data JSON yang masuk diformat menjadi notifikasi.

Pola Dasar ​

PolaDeskripsi
*Menampilkan seluruh payload JSON
%field%Mengambil field tingkat atas
%object.field%Mengambil field bersarang
%array.0%Mengambil elemen pertama dari array
%array.0.field%Mengambil field dari elemen array
%%Karakter % literal. Hanya diperlukan tepat sebelum sebuah kata yang diikuti % lain, seperti %cpu%%%; % yang diikuti spasi, seperti 90% on %host%, tetap ditulis apa adanya

Placeholder tidak pernah mengandung spasi, sehingga tanda persen dalam teks biasa dibiarkan begitu saja: CPU over 90% on %host% akan ditampilkan sebagai CPU over 90% on db-1.

Contoh ​

Contoh Payload JSON ​

Perhatikan payload webhook yang masuk berikut:

json
{
  "event": {
    "title": "New Order",
    "message": "A new order has been placed with ID 12345",
    "tags": ["order", "new"],
    "users": [
      {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]},
      {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]},
      {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]}
    ]
  }
}

Konfigurasi Template ​

text
*
text
Title: %event.title%
Message: %event.message%
Tags: %event.tags%
Users: %event.users.0%
First user: %event.users.0.first% %event.users.0.last%

Hasil Output ​

Title: New Order
Message: A new order has been placed with ID 12345
Tags: ["order","new"]
Users: {"age":44,"first":"Dale","last":"Murphy","nets":["ig","fb","tw"]}
First user: Dale Murphy

Integrasi Umum ​

Webhook GitHub ​

text
🔔 %action%: %repository.full_name%
%sender.login%: %commits.0.message%

Pelacakan Error Sentry ​

Untuk integrasi internal yang digunakan sebagai aksi alert (issue alerts):

text
🚨 %data.event.title%
%data.event.culprit%
Rule: %data.triggered_rule%

Tambahkan tombol view dengan %data.event.web_url% untuk membuka issue. Plugin Webhooks lama mengirim payload yang berbeda: di sana, gunakan %project_name%: %event.title% dan %url%.

Alert Grafana ​

text
⚠️ %state%: %title%

%message%

Status: %status%

Uptime Robot ​

text
🔴 %monitorFriendlyName%
Status: %alertTypeFriendlyName%
Details: %alertDetails%

Sintaks Path Lanjutan ​

Untuk ekstraksi JSON yang kompleks, kami menggunakan GJSON Path Syntax.

Pola yang Berguna ​

PolaDeskripsi
%users.#%Jumlah item array
%users.#.first%Array dari semua nilai first
%users.@reverse%Membalik urutan array
%data.@pretty%Mencetak JSON dengan format rapi

Pelajari Lebih Lanjut

Dokumentasi lengkap: GJSON Path Syntax

Tingkat Prioritas ​

Payload yang masuk dapat menyertakan field level untuk mengontrol cara push notification dikirim — berupa nama (silent, low, default, high, critical) atau integer (-2..2). Lihat Tingkat prioritas pesan.

Urutan penentuan (kecocokan pertama yang dipakai):

  1. Field level dalam payload JSON yang masuk
  2. default_level webhook (diatur saat membuat webhook)
  3. Tingkat default aplikasi
  4. default (normal)

Berbeda dengan API langsung, input webhook bersifat toleran: nilai level yang tidak dikenali akan diabaikan (kembali ke nilai default) alih-alih ditolak, sehingga notifikasi tidak pernah hilang.

Tombol Aksi ​

Sebuah webhook dapat melampirkan hingga 3 tombol aksi ke setiap notifikasi yang dihasilkannya. Atur field actions (berupa string JSON) saat membuat atau memperbarui webhook — lihat Create Webhook → Template Tombol Aksi.

label dan value mendukung placeholder %field.path% yang sama dengan template pesan, sehingga tombol dapat dibangun dari payload yang masuk:

json
[
  { "type": "view", "label": "Open PR", "value": "%pull_request.html_url%" },
  { "type": "http", "label": "Merge", "value": "{\"url\":\"https://ci.example.com/merge/%pull_request.number%\",\"method\":\"POST\"}" }
]

Setelah substitusi, setiap tombol divalidasi (type ∈ view/http/copy, view dan http memerlukan URL http(s)). Seperti parsing level, ini bersifat toleran: tombol yang tidak valid dibuang secara terpisah, dan tombol lain beserta notifikasinya tetap dikirim.

Tombol aksi adalah fitur berbayar. Pada paket gratis, tombol dihapus dan notifikasi tetap dikirim tanpa tombol tersebut.

Setelah membuat webhook, Anda dapat mengujinya:

bash
curl -X POST "https://p4a.me/wh/YOUR_WEBHOOK_URL" \
  -H "Content-Type: application/json" \
  -d '{"event": {"title": "Test", "message": "Hello World"}}'
javascript
await fetch('https://p4a.me/wh/YOUR_WEBHOOK_URL', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    event: { title: 'Test', message: 'Hello World' }
  })
});
python
import requests

requests.post(
    'https://p4a.me/wh/YOUR_WEBHOOK_URL',
    json={'event': {'title': 'Test', 'message': 'Hello World'}}
)
php
Http::post('https://p4a.me/wh/YOUR_WEBHOOK_URL', [
    'event' => [
        'title' => 'Test',
        'message' => 'Hello World',
    ],
]);

Ini akan mengirim notifikasi uji ke perangkat Anda menggunakan template pesan yang telah dikonfigurasi.

Dokumentasi Pocket Alert