List event types

GET/v1/event-typesRun

Requires webhooks:read permission.

Response (200)

dataarray of objectrequired

The returned object, or an array of objects for a list.

typestringrequired

The event type, as you subscribe to it.

Example: payment.succeeded

Possible values: 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

groupstringrequired

The family of the event: payment, payment_link, invoice, project, api_key, webhook_endpoint or test.

Example: payment

Possible values: payment, payment_link, invoice, project, api_key, webhook_endpoint, test

scopestringrequired

project events reach the project's endpoints and the merchant's; account events only the merchant's.

Example: project

Possible values: project, account

descriptionstringrequired

The condition that causes Baiyar to send this event to subscribed webhook endpoints.

Example: A payment was paid.

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl "https://api.baiyar.com/v1/event-types" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

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