Skip to main content
GET
Get an event

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Path Parameters

id
string
required
Example:

"event_2wq8n5hkd7xm3rpa"

Response

The event.

The start of type says which object data.object is. It's a snapshot from when the event happened.

id
string
required

Also sent as the webhook-id header.

Example:

"event_2wq8n5hkd7xm3rpa"

type
enum<string>
required
Available options:
payout.created,
payout.updated,
payout.awaiting_funds,
payout.pending,
payout.processing,
payout.paid,
payout.failed,
payout.returned,
payout.canceled,
payout.expired,
batch.created,
batch.processing,
batch.awaiting_funds,
batch.awaiting_payees,
batch.completed,
batch.partially_completed,
batch.failed,
batch.canceled,
payee.created,
payee.details_pending,
payee.verifying,
payee.active,
payee.inactive,
deposit.created
Example:

"payout.paid"

created_at
string<date-time>
required

When the change happened, not when it was delivered.

Example:

"2026-10-26T10:05:30Z"

api_version
enum<string>
required
Available options:
v1
environment
enum<string>
required
Available options:
live,
sandbox
Example:

"sandbox"

data
object
required