Langsung ke konten utama
GET
curl

Status tujuan

health_status merangkum seberapa baik tujuan ini merespons pengiriman. Percobaan yang gagal adalah percobaan yang dijawab tujuan dengan HTTP 400 atau lebih, atau yang sama sekali tidak dijawab (timeout, koneksi ditolak, atau alamat diblokir). Coba lagi tidak menambah failing_streak, dan setiap percobaan yang berhasil, termasuk coba lagi atau pengiriman ulang, mengakhiri rangkaian kegagalan. health_status tidak bergantung pada enabled. Metrik pengiriman dan daily_points mencakup 30 hari terakhir (metrics_window_days). daily_points selalu berisi 30 entri, satu per hari UTC, dari yang paling lama.

Terkait

Otorisasi

x-api-key
string
header
wajib

Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.

Respons

Daftar tujuan webhook (tanpa paginasi, terlama lebih dahulu).

uuid
string<uuid>

Pengidentifikasi tujuan yang stabil; gunakan sebagai {destination_uuid} untuk pembaruan/penghapusan.

label
string

Nama yang mudah dibaca manusia yang ditampilkan di Console.

url
string<uri>

URL tujuan yang menerima permintaan POST dengan payload webhook.

enabled
boolean

Jika false, Didit tidak melakukan pengiriman ke tujuan ini tanpa menampilkan peringatan.

webhook_version
enum<string>

Versi skema payload yang dikirim ke tujuan ini. v3 adalah format saat ini/yang direkomendasikan.

Opsi yang tersedia:
v1,
v2,
v3
subscribed_events
enum<string>[]

Filter event untuk tujuan webhook ini. Didit hanya mengirimkan webhook yang tipe event-nya sama persis dengan salah satu nilai ini — tidak ada langganan wildcard. Saat dikirim, daftar ini harus berisi setidaknya satu event yang valid ([] eksplisit akan ditolak dengan kode 400); tujuan yang daftarnya kosong (kolom tidak disertakan saat pembuatan) tidak akan menerima apa pun. Saat pembaruan, daftar diganti secara keseluruhan, tidak pernah digabungkan.

Minimum array length: 1

Nama event webhook yang didukung. Gunakan string persis ini di subscribed_events; nilai yang tidak didukung akan ditolak.

Opsi yang tersedia:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
Contoh:
subscribed_events_count
integer

Panjang subscribed_events yang di-cache, berguna untuk rendering UI.

deliveries_count
integer

Upaya pengiriman (termasuk percobaan ulang) yang dilakukan ke tujuan ini dalam 30 hari terakhir.

failed_deliveries_count
integer

Upaya pengiriman dalam 30 hari terakhir yang dijawab tujuan dengan HTTP 400 ke atas, atau tidak dijawab (waktu habis, koneksi ditolak, atau alamat diblokir).

average_response_time_ms
integer | null

Waktu respons rata-rata dalam milidetik selama 30 hari terakhir, dibulatkan ke bilangan bulat. null jika tidak ada pengiriman dalam jangka waktu tersebut.

error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) selama 30 hari terakhir; 0 saat tidak ada pengiriman.

last_delivery_at
string<date-time> | null

Cap waktu upaya pengiriman terbaru (berhasil atau gagal). null jika belum pernah dikirimkan.

metrics_window_days
integer

Panjang dalam hari dari jendela yang dicakup oleh deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage, dan daily_points. Selalu 30.

health_status
enum<string>

Status pengiriman. failing: 3 event berturut-turut atau lebih gagal pada upaya pengiriman pertamanya sejak tujuan terakhir kali merespons dengan berhasil (lihat failing_streak). degraded: tidak gagal (failing), tetapi upaya pengiriman gagal dalam 24 jam terakhir dan tidak ada upaya berikutnya yang berhasil mengirimkan event tersebut; percobaan ulang atau pengiriman ulang yang berhasil menyelesaikannya akan menghapus status ini. healthy: tidak keduanya. Independen dari enabled. Upaya yang gagal adalah upaya yang direspons dengan HTTP 400 ke atas, atau tidak direspons sama sekali.

Opsi yang tersedia:
healthy,
degraded,
failing
failing_streak
integer

Berapa banyak event berturut-turut yang gagal pada upaya pengiriman pertamanya sejak tujuan terakhir kali merespons dengan berhasil, dalam 30 hari terakhir. Coba lagi tidak dihitung, dan setiap upaya yang berhasil, termasuk coba lagi atau pengiriman ulang, mengakhiri rentetan tersebut. 0 jika tidak ada event yang gagal sejak keberhasilan terakhir.

failing_since
string<date-time> | null

Waktu ketika upaya gagal pertama dari failing_streak saat ini dilakukan. null jika failing_streak bernilai 0.

last_success_at
string<date-time> | null

Waktu ketika tujuan terakhir kali merespons pengiriman dengan status HTTP di bawah 400, dalam 30 hari terakhir. null jika tidak merespons dalam rentang waktu tersebut.

environment
enum<string>

Lingkungan aplikasi yang memiliki tujuan tersebut.

Opsi yang tersedia:
live,
sandbox
daily_points
object[]

Satu entri per hari UTC dalam 30 hari terakhir, yang terlama terlebih dahulu, termasuk hari-hari tanpa pengiriman. Menghitung setiap upaya, termasuk coba lagi.

secret_last4
string

Empat karakter terakhir dari rahasia penandatanganan tujuan saat ini, sehingga Anda dapat membedakan rahasia. Tidak cukup untuk memverifikasi tanda tangan.

created_by_email
string | null

Email anggota Business Console yang membuat tujuan. null untuk tujuan yang dibuat dengan kunci API.

created_by_name
string | null

Nama anggota Business Console yang membuat tujuan. Bernilai null untuk tujuan yang dibuat dengan kunci API.

created_at
string<date-time>
updated_at
string<date-time>
Terakhir diubah pada 7 November 2026