GET
Get an event

Authorizations

Authorization
string
header
default:sk_test_docs_246e232c64ccc7a001bf61ec0f2e6ab0
required

Authorization: Bearer <secret key>. Secret keys belong to your organisation, are shown once when created in the dashboard, and are scoped (see x-required-scope on each operation). Keep them on your server. Live keys are issued after your business is verified. Publishable keys (pk_) are only for @ketapay/checkout and don't work here.

Path Parameters

id
string<uuid>
required

Response

The event

id
string<uuid>
required

Deduplicate on this

object
string
required
Allowed value: "event"
type
enum<string>
required

New event types may be added. Ignore types you don't handle.

Available options:
checkout_session.expired,
escrow.funded,
milestone.delivered,
milestone.released,
escrow.completed,
escrow.refunded,
dispute.opened,
dispute.evidence_requested,
dispute.evidence_submitted,
dispute.resolved,
payout.sent,
refund.sent,
refund.failed,
chargeback.opened,
chargeback.closed,
payout.failed
api_version
string
required
Allowed value: "v1"
livemode
boolean
required
created_at
string<date-time>
required
data
object
required