pub struct Event {
pub account: Option<String>,
pub api_version: Option<String>,
pub context: Option<String>,
pub created: i64,
pub data: NotificationEventData,
pub id: EventId,
pub livemode: bool,
pub pending_webhooks: i64,
pub request: Option<NotificationEventRequest>,
pub type_: EventType,
}
Expand description
Snapshot events allow you to track and react to activity in your Stripe integration. When
the state of another API resource changes, Stripe creates an Event
object that contains
all the relevant information associated with that action, including the affected API
resource. For example, a successful payment triggers a charge.succeeded
event, which
contains the Charge
in the event’s data property. Some actions trigger multiple events.
For example, if you create a new subscription for a customer, it triggers both a
customer.subscription.created
event and a charge.succeeded
event.
Configure an event destination in your account to listen for events that represent actions your integration needs to respond to. Additionally, you can retrieve an individual event or a list of events from the API.
Connect platforms can also receive event notifications that occur in their connected accounts. These events include an account attribute that identifies the relevant connected account.
You can access events through the Retrieve Event API. for 30 days.
For more details see <https://stripe.com/docs/api/events/object>.
Fields§
§account: Option<String>
The connected account that originates the event.
api_version: Option<String>
The Stripe API version used to render data
when the event was created.
The contents of data
never change, so this value remains static regardless of the API version currently in use.
This property is populated only for events created on or after October 31, 2014.
context: Option<String>
Authentication context needed to fetch the event or related object.
created: i64
Time at which the object was created. Measured in seconds since the Unix epoch.
data: NotificationEventData
§id: EventId
Unique identifier for the object.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
pending_webhooks: i64
Number of webhooks that haven’t been successfully delivered (for example, to return a 20x response) to the URLs you specify.
request: Option<NotificationEventRequest>
Information on the API request that triggers the event.
type_: EventType
Description of the event (for example, invoice.created
or charge.refunded
).