Arsitektur Dokumentasi

Webhook memungkinkan sistem Anda sendiri bereaksi ketika sesuatu terjadi di Tulis — misalnya, membangun ulang situs statis atau mengirim ke Slack setiap kali sebuah posting diterbitkan. Webhook adalah fitur admin: bersifat workspace-scoped dan memerlukan JWT dengan peran admin, bukan kunci API publik.

Autentikasi

Endpoint webhook bukan bagian dari API publik. Mereka memerlukan:

Ini adalah JWT yang diterbitkan untuk pengguna admin yang terautentikasi, bukan Bearer <API_KEY> yang digunakan oleh endpoint publik. Tidak perlu header X-Workspace-ID — webhook sudah terbatas pada workspace admin.

Endpoint

Membuat webhook

curl -X POST "https://YOUR_HOST/api/webhooks" \
  -H "Authorization: Bearer ***" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/tulis",
    "event": "after_create_post"
  }'

Melihat dan menghapus webhook

# Lihat daftar
curl "https://YOUR_HOST/api/webhooks" \
  -H "Authorization: Bearer ***"

# Hapus
curl -X DELETE "https://YOUR_HOST/api/webhooks/<WEBHOOK_ID>" \
  -H "Authorization: Bearer ***"

Melihat log pengiriman

curl "https://YOUR_HOST/api/webhooks/<WEBHOOK_ID>/logs" \
  -H "Authorization: Bearer ***"

Kasus penggunaan: build ulang saat publikasi

Arahkan webhook ke URL pemicu pipeline build situs statis Anda. Ketika Tulis memicu event publikasi, pipeline Anda membangun ulang dan men-deploy ulang situs dengan konten baru. Anda juga dapat meneruskan event ke URL incoming-webhook Slack untuk memberi tahu tim Anda.

Event

Webhook diaktifkan melalui hook plugin platform. Nama event representatif meliputi before_create_post, after_create_post, before_update_post, dan after_update_post. (Nama-nama ini bersifat representatif — konfirmasi identifier event yang tepat yang tersedia di versi Tulis Anda sebelum mengandalkannya.)

Pengingat: webhook hanya untuk admin. Gunakan JWT dari pengguna admin; kunci API publik tidak dapat membuat, mencantumkan, atau menghapus webhook.