Skip to main content
This object represents a webhook event in Charge. Events are immutable snapshots of resource changes that Charge delivers to your webhook endpoints.

Attributes

id
string
required
Unique identifier for the object.
api_version
string | null
API version used to render data when this event was created.
data
object
required
Object containing the resource snapshot for the event.
request
object | null
Information about the API request that triggered the event, if any.
type
string
required
Type of the event.Available options: charge.succeeded, report.succeeded

More attributes

object
string
required
String representing the object’s type.Available options: event
created
string
required
Time at which the event was created. RFC 3339 UTC timestamp with millisecond precision, e.g. 2026-03-03T14:05:23.789Z.
livemode
boolean
required
Indicates whether the event was generated in live or test mode.
pending_webhooks
integer
required
Number of webhook endpoints that have not yet acknowledged this event.