Daftar jenis event

GET/v1/event-typesJalankan

Membutuhkan izin webhooks:read.

Respons (200)

dataarray dari objectwajib

Objek yang dikembalikan, atau array objek untuk operasi daftar.

typestringwajib

Jenis event, seperti yang kamu ikuti.

Contoh: payment.succeeded

Nilai yang mungkin: payment.created, payment.succeeded, payment.failed, payment.expired, payment.settled, payment.anomaly, payment.unsettled, payment.reversed, payment.reversal_cancelled, payment.attempt.created, payment.attempt.failed, payment_link.created, payment_link.cancelled, payment_link.expired, payment_link.completed, payment_link.limit_reached, invoice.issued, invoice.paid, invoice.voided, project.created, project.updated, project.activated, project.deactivated, project.payment_methods_changed, project.live_requested, project.live_approved, project.live_revision_requested, api_key.created, api_key.rotated, api_key.revoked, webhook_endpoint.created, webhook_endpoint.updated, webhook_endpoint.deleted, webhook_endpoint.secret_rotated, webhook_endpoint.disabled, webhook.test

groupstringwajib

Keluarga event: payment, payment_link, invoice, project, api_key, webhook_endpoint, atau test.

Contoh: payment

Nilai yang mungkin: payment, payment_link, invoice, project, api_key, webhook_endpoint, test

scopestringwajib

Event project sampai ke endpoint proyek dan endpoint merchant; event account hanya ke endpoint merchant.

Contoh: project

Nilai yang mungkin: project, account

descriptionstringwajib

Kondisi yang membuat Baiyar mengirim event ini ke endpoint webhook yang berlangganan.

Contoh: A payment was paid.

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 "https://api.baiyar.com/v1/event-types" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Respons

{
  "data": [
    {
      "type": "payment.succeeded",
      "group": "payment",
      "scope": "project",
      "description": "A payment was paid."
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}