Get an event

Returns the stored event envelope: its event ID, type, timestamp and payload.

GET/v1/events/{id}

Requires webhooks:read permission.

idstringrequired

The id of the event (wev_…).

Example: wev_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with wev_.

dataobjectrequired

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

Values: object

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.

curl "https://api.baiyar.com/v1/events/{id}" \
  -H "Authorization: Bearer $BAIYAR_KEY"

{
  "data": {},
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}