Ubah endpoint webhook

PATCH/v1/webhook-endpoints/{id}Jalankan

Membutuhkan izin webhooks:write.

Parameter path

idstringwajib

Id endpoint (whk_…).

Contoh: whk_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali whk_.

Body request

urlstringopsional

Alamat HTTPS publik yang dipanggil Baiyar untuk tiap event.

Contoh: https://toko.example.com/webhooks/baiyar

Panjang minimum: 8

Panjang maksimum: 2048

descriptionstring | nullopsional

Label internal untuk membedakan endpoint ini dari endpoint webhook lain.

Contoh: Server produksi

Panjang minimum: 1

Panjang maksimum: 200

eventsarray dari stringopsional

Jenis atau pola event yang diikuti, seperti payment.*. Kosong berarti semua event.

Item maksimum: 40

statusstringopsional

active, disabled (dimatikan olehmu), atau auto_disabled (dimatikan setelah gagal berulang).

Contoh: active

Nilai yang mungkin: active, disabled

Respons (200)

dataobjectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

idstringwajib

Id endpoint (whk_…).

Contoh: whk_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali whk_.

livemodebooleanwajib

true berarti objek ini ada di live dan bisa melibatkan pembayaran sungguhan; false berarti objek ini ada di sandbox.

scopestringwajib

project menerima event dari satu proyek; merchant menerima event dari semua proyek di akun.

Contoh: project

Nilai yang mungkin: project, merchant

project_idstring | nullwajib

Proyek milik endpoint proyek; null untuk endpoint merchant.

Contoh: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Diawali prj_.

urlstringwajib

Alamat HTTPS publik yang dipanggil Baiyar untuk tiap event.

Contoh: https://toko.example.com/webhooks/baiyar

descriptionstring | nullwajib

Label internal untuk membedakan endpoint ini dari endpoint webhook lain.

Contoh: Server produksi

eventsarray dari stringwajib

Jenis atau pola event yang diikuti, seperti payment.*. Kosong berarti semua event.

statusstringwajib

active, disabled (dimatikan olehmu), atau auto_disabled (dimatikan setelah gagal berulang).

Contoh: active

Nilai yang mungkin: active, disabled, auto_disabled

disabled_reasonstring | nullwajib

Alasan pengiriman dihentikan. Null selama endpoint aktif.

Contoh: string

consecutive_failuresintegerwajib

Berapa pengiriman berturut-turut yang menghabiskan semua percobaan. Pada 5 endpoint dimatikan.

Contoh: 0

secretsarray dari objectwajib

Secret yang saat ini diterima untuk memverifikasi tanda tangan webhook. Dua secret muncul selama rotasi; hanya empat karakter terakhir yang ditampilkan.

last4stringwajib

Empat karakter terakhir rahasia, untuk membedakan. Rahasianya sendiri tidak pernah ditampilkan lagi.

Contoh: Xk3a

statusstringwajib

active, atau retiring (masih menandatangani selama sehari setelah rotasi).

Contoh: active

Nilai yang mungkin: active, retiring

retire_atstring | nullwajib

Kapan rahasia yang dipensiunkan berhenti menandatangani; null untuk yang aktif.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

created_atstringwajib

Waktu objek ini dibuat (RFC 3339, UTC). Gunakan untuk mengurutkan objek berdasarkan waktu pembuatan.

Contoh: 2026-10-26T03:04:05.000Z

Format: date-time

metaobjectwajib

Detail request seperti id dan kursor paginasi.

request_idstringwajib

Id request ini. Sebutkan saat bertanya ke dukungan.

Contoh: req_Hy3k9QzT2LmN8vXa

Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.

Request

curl -X PATCH "https://api.baiyar.com/v1/webhook-endpoints/{id}" \
  -H "Authorization: Bearer $BAIYAR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Server produksi"
  }'

Respons

{
  "data": {
    "id": "whk_01k7q3m8x2v5t9n4b6c1d0e7fa",
    "livemode": false,
    "scope": "project",
    "project_id": "prj_01k7q3m8x2v5t9n4b6c1d0e7fa",
    "url": "https://toko.example.com/webhooks/baiyar",
    "description": "Server produksi",
    "events": [
      "payment.succeeded",
      "payment.failed"
    ],
    "status": "active",
    "disabled_reason": "string",
    "consecutive_failures": 0,
    "secrets": [
      {
        "last4": "Xk3a",
        "status": "active",
        "retire_at": "2026-10-26T03:04:05.000Z"
      }
    ],
    "created_at": "2026-10-26T03:04:05.000Z"
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}