Skip to content

Events

An event records a change in your account. Events are what webhooks deliver, and you can also list them, for example to catch up after your endpoint was down.

Field Type Description
id string Unique ID, prefix evt_. Use it to deduplicate.
object string Always event.
type string One of the event types.
livemode boolean true for live mode.
created_at timestamp When the event happened.
data.object object The paper, submission, balance or account, as it was at created_at.

GET /v1/events

Parameter Description
type Only events of this type, for example submission.released.
object_id Only events about this paper or submission.
created_after, created_before, limit, cursor As described in Lists and pagination.

Events are kept for 30 days.

GET /v1/events/{id}