Berlangganan webhook
Dapatkan notifikasi saat peristiwa penting terjadi tanpa polling.
Sesi adalah interaksi yang berjalan lama. Meskipun sebagian besar interaksi real-time terjadi melalui aliran event SSE, webhook memberi tahu Anda tentang perubahan status yang penting.
Event webhook mengembalikan type dan id event, bukan objek lengkapnya. Saat Anda menerima event webhook, Anda perlu mengambil objek tersebut secara langsung dengan panggilan GET. Hal ini menghindari pengiriman data usang saat percobaan ulang dan menjaga setiap pengiriman tetap kecil.
Jenis event yang didukung
Beberapa event ini diberi nama yang berbeda dari event yang sesuai pada aliran event sesi. Misalnya, session.status_idle dan session.status_running pada aliran tersebut sesuai dengan event webhook session.status_idled dan session.status_run_started.
| Event | Pemicu |
|---|---|
session.status_run_started | Eksekusi agen dimulai. Ini dipicu pada setiap transisi status sesi ke running. |
session.status_idled | Agen menunggu input, misalnya, persetujuan izin alat atau pesan pengguna baru. |
session.budget_reached | Sesi mencapai anggarannya dan dijeda. Dipicu paling banyak sekali untuk setiap nilai anggaran yang Anda tetapkan; mengubah anggaran akan mengaktifkannya kembali. |
session.status_rescheduled | Terjadi kesalahan sementara dan sesi mencoba ulang secara otomatis. |
session.status_terminated | Sesi dihentikan, baik karena kesalahan yang tidak dapat dipulihkan atau karena diarsipkan. |
session.thread_created | Thread multiagen baru dibuka: agen tambahan yang dipanggil oleh agen yang dijalankan sesi mulai bekerja, atau advisor sesi sedang dikonsultasikan. Event ini juga dipicu untuk setiap thread dari workflow run, begitu pula dua event thread lainnya dalam tabel ini. |
session.thread_idled | Agen dalam interaksi multiagen sedang menunggu input. |
session.thread_terminated | Thread multiagen dihentikan, baik karena thread diarsipkan atau karena telah menghabiskan percobaan ulangnya. Subagen yang menyelesaikan pekerjaannya menjadi idle, bukan terminated (thread advisor dihentikan setelah konsultasinya selesai, dan thread dari workflow run dihentikan saat server mengarsipkannya, pada akhir run). Hanya dipicu untuk thread anak; berakhirnya thread utama, termasuk pengarsipan seluruh sesi, hanya muncul sebagai session.status_terminated. |
session.outcome_evaluation_ended | Evaluasi hasil untuk satu iterasi selesai. |
session.updated | Properti sesi berubah (misalnya, nama atau konfigurasinya diperbarui). |
session.deleted | Sesi dihapus secara permanen. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
| Event | Pemicu |
|---|---|
vault.created | Vault dibuat. |
vault.archived | Vault diarsipkan. Event vault_credential.archived juga dipancarkan untuk setiap kredensial di dalamnya. |
vault.deleted | Vault dihapus. Event vault_credential.deleted juga dipancarkan untuk setiap kredensial di dalamnya. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
vault_credential.created | Kredensial dibuat. |
vault_credential.archived | Kredensial diarsipkan, baik secara langsung atau sebagai akibat dari pengarsipan vault. |
vault_credential.deleted | Kredensial dihapus, baik secara langsung atau sebagai akibat dari penghapusan vault. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
vault_credential.refresh_failed | Kredensial mcp_oauth tidak dapat diperbarui (refresh token tidak valid, atau kesalahan yang tidak dapat dipulihkan dari server OAuth). |
Event ini melacak siklus hidup sumber daya agen di workspace Anda, dan berbeda dari event agen yang dikirimkan pada aliran event sesi.
| Event | Pemicu |
|---|---|
agent.created | Agen dibuat. |
agent.updated | Versi baru agen dipublikasikan. Pembaruan yang tidak membuat versi baru tidak memicu event ini. |
agent.archived | Agen diarsipkan. |
agent.deleted | Agen dihapus secara permanen. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
| Event | Pemicu |
|---|---|
deployment.created | Deployment terjadwal dibuat. |
deployment.updated | Properti deployment berubah (misalnya, jadwalnya diperbarui). |
deployment.paused | Deployment dijeda, baik atas permintaan atau secara otomatis saat run terjadwal gagal dengan kesalahan yang tidak dapat dipulihkan, seperti subagen yang diarsipkan atau environment yang diarsipkan. Kegagalan yang dapat dipulihkan, termasuk batas laju, tidak menjeda deployment. Lihat Perilaku kegagalan. |
deployment.unpaused | Jeda deployment dibatalkan, melanjutkan jadwalnya. |
deployment.archived | Deployment diarsipkan, baik secara langsung atau karena agennya diarsipkan. Jika agen dihapus, deployment terjadwal diarsipkan pada run terjadwal berikutnya; deployment tanpa jadwal tidak diarsipkan secara otomatis. |
deployment.deleted | Deployment dihapus secara permanen. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
| Event | Pemicu |
|---|---|
deployment_run.started | Run terjadwal dimulai. Hanya run terjadwal yang memancarkan event deployment_run; run manual tidak. |
deployment_run.succeeded | Run terjadwal membuat sesinya. Event ini membawa data.id (ID run) yang sama dengan event deployment_run.started milik run tersebut. Untuk mengikuti pekerjaan sesi, berlanggananlah ke event sesinya (tab Event sesi), atau ambil deployment run untuk mendapatkan session_id-nya. |
deployment_run.failed | Run terjadwal tidak membuat sesi. Event ini membawa data.id yang sama dengan event deployment_run.started milik run tersebut. Ambil deployment run untuk detail kesalahannya. |
| Event | Pemicu |
|---|---|
environment.created | Environment dibuat. |
environment.updated | Environment diperbarui dengan setidaknya satu field yang berubah. Pembaruan tanpa perubahan tidak memancarkan apa pun. |
environment.archived | Environment diarsipkan. Mengarsipkan ulang environment yang sudah diarsipkan tidak memancarkan apa pun. |
environment.deleted | Environment dihapus, termasuk penghapusan environment yang sudah diarsipkan. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
Work item milik environment tidak memancarkan event webhook.
| Event | Pemicu |
|---|---|
memory_store.created | Memory store dibuat, baik oleh Anda atau oleh proses yang dioperasikan Anthropic yang mengkloning salah satu store Anda yang sudah ada. |
memory_store.archived | Memory store diarsipkan. Mengarsipkan ulang store yang sudah diarsipkan tidak memancarkan apa pun. |
memory_store.deleted | Memory store dihapus, termasuk penghapusan store yang sudah diarsipkan. Menghapus store akan menghapus secara berantai memori dan versi memorinya tanpa memancarkan event per memori; satu event memory_store.deleted adalah sinyalnya. Tidak ada objek yang tersisa untuk diambil, jadi perlakukan event itu sendiri sebagai final. |
Memori individual dan versi memori tidak memancarkan event webhook.
Mendaftarkan endpoint
Di Claude Console, buka halaman Webhooks (platform.claude.com/settings/workspaces/default/webhooks). Setiap endpoint dimiliki oleh satu workspace. Pilih workspace yang Anda inginkan di pemilih workspace pada sidebar.
Endpoint webhook terdiri dari:
- URL: Harus HTTPS pada port 443 dengan hostname yang dapat di-resolve secara publik.
- Jenis event: Daftar nilai
data.typeyang diterima endpoint ini. Endpoint hanya menerima event yang dilanggankannya. - Signing secret: Secret 32-byte berawalan
whsec_yang dibuat saat pembuatan. Secret ini hanya ditampilkan sekali, jadi simpan dengan aman untuk memverifikasi pengiriman webhook.
Memverifikasi tanda tangan
Setiap pengiriman membawa header webhook-id, webhook-timestamp, dan webhook-signature. Gunakan helper unwrap() dari SDK untuk memverifikasi tanda tangan dan mem-parsing event dalam satu langkah. Helper ini akan melempar error jika tanda tangan tidak valid atau payload berusia lebih dari 5 menit.
Atur ANTHROPIC_WEBHOOK_SIGNING_KEY ke secret berawalan whsec_ yang ditampilkan saat pembuatan endpoint.
from flask import Flask, request
import anthropic
client = anthropic.Anthropic() # reads ANTHROPIC_WEBHOOK_SIGNING_KEY from env
app = Flask(__name__)
@app.route("/webhook", methods=["POST"])
def webhook():
try:
# unwrap() memunculkan error jika tanda tangan tidak valid atau payload sudah kedaluwarsa
event = client.beta.webhooks.unwrap(
request.get_data(as_text=True),
headers=dict(request.headers),
)
except Exception:
return "invalid signature", 400
if event.data.type == "session.status_idled":
print("session idled:", event.data.id)
# tangani jenis event lainnya
return "", 200Menangani event
Parsing body, lakukan switch pada data.type, dan ambil sumber daya berdasarkan ID. Kembalikan 2xx apa pun untuk mengonfirmasi penerimaan. Respons lain apa pun akan dihitung merugikan endpoint: 3xx langsung menonaktifkannya (redirect tidak pernah diikuti), sementara kegagalan lainnya dicoba ulang; lihat Perilaku pengiriman untuk aturan percobaan ulang dan penonaktifan otomatis.
Setiap payload event memiliki struktur yang sama, termasuk jenis event, pengenal, dan timestamp kapan event terjadi.
{
"type": "event",
"id": "whe_9d5c1f7e...",
"created_at": "2026-03-18T14:05:22Z",
"data": {
"type": "session.status_idled",
"id": "sesn_01XYZ...",
"organization_id": "8a3d2f1e-...",
"workspace_id": "c7b0e4d9-..."
}
}if event.data.type == "session.status_idled":
session = client.beta.sessions.retrieve(event.data.id)
notify_user(session)
return "", 204event.id tingkat atas bersifat unik per event, bukan per pengiriman. Jika Anda menerima event.id yang sama dua kali, itu adalah percobaan ulang dan Anda dapat membuangnya.
Perilaku pengiriman
-
Duplikat: Endpoint dapat menerima event yang sama lebih dari sekali, dan setiap percobaan mengirimkan
event.idtingkat atas yang sama (nilai yang sama dengan headerwebhook-id). Lakukan deduplikasi berdasarkan nilai tersebut. -
Cakupan langganan: Event hanya dikirimkan ke endpoint yang berlangganan jenisnya pada saat event dipancarkan. Event yang dipancarkan saat tidak ada endpoint yang berlangganan jenisnya tidak akan pernah dikirimkan, dan berlangganan kemudian tidak akan mengisinya kembali, jadi berlanggananlah ke suatu jenis event sebelum Anda membutuhkannya.
-
Urutan tidak dijamin. Event tidak dikirimkan sesuai urutan terjadinya:
session.status_idledmungkin tiba sebelumsession.outcome_evaluation_endedmeskipun hasilnya dihasilkan lebih dulu, dan event.deleteddapat tiba sebelum event.archiveduntuk sumber daya yang sama. Tentukan state Anda berdasarkan sumber daya yang Anda ambil, bukan berdasarkan urutan kedatangan event. -
Percobaan ulang: Untuk setiap endpoint dan event, Anthropic melakukan hingga tiga percobaan pengiriman (respons yang memicu penonaktifan otomatis, yang dijelaskan nanti di bagian ini, tidak pernah dicoba ulang) dengan "exponential backoff" (penundaan eksponensial) ber-jitter antara 5 dan 120 detik. Setiap percobaan mengirimkan
event.idyang sama. Setelah percobaan terakhir gagal, event dibuang: event tidak diantrekan untuk pengiriman nanti dan tidak ada sinyal bahwa event tersebut hilang. Webhook bukanlah log yang tahan lama, jadi jika Anda perlu mengamati setiap transisi, lakukan rekonsiliasi dengan mendaftar atau mengambil sumber daya melalui API. -
Timestamp: Header
webhook-timestampdicap saat percobaan pengiriman ditandatangani dan dibuat ulang pada setiap percobaan ulang, sehingga percobaan ulang tidak ditolak oleh pemeriksaan kesegaran SDK. Ini adalah jam untuk percobaan pengiriman, bukan untuk event: gunakancreated_atdari payload event untuk mengetahui kapan event terjadi. -
Penonaktifan otomatis: Endpoint secara otomatis diatur ke
disableddengandisabled_reasonyang dapat dibaca mesin dalam tiga kasus:- Endpoint mengembalikan respons
3xx. Redirect tidak pernah diikuti; ini langsung menonaktifkan endpoint, pada percobaan pertama, dengan alasanauto-disabled: endpoint URL returned a redirect (3xx). Jika endpoint Anda berpindah, perbarui URL di Console dan aktifkan kembali endpoint tersebut. - URL endpoint di-resolve ke alamat IP non-publik saat Anthropic terhubung. Ini langsung menonaktifkan endpoint, dengan alasan
auto-disabled: endpoint URL resolved to an invalid address. - Pengiriman ke endpoint gagal terus-menerus selama periode yang berkelanjutan, dengan alasan
auto-disabled after sustained delivery failures. Pemicunya adalah berapa lama endpoint telah gagal tanpa jeda, bukan jumlah pengiriman. Satu2xxsaja akan mengatur ulang jendela waktu tersebut, sehingga satu event yang tidak stabil tidak dapat menonaktifkan endpoint.
Ketiganya dapat dipulihkan: aktifkan kembali endpoint di Console setelah Anda menyelesaikan masalahnya. Event yang dipancarkan saat endpoint dinonaktifkan tidak akan diputar ulang.
- Endpoint mengembalikan respons
Was this page helpful?