Struct Event

pub struct Event {
    pub account: Option<String>,
    pub api_version: Option<String>,
    pub created: i64,
    pub data: NotificationEventData,
    pub id: String,
    pub livemode: bool,
    pub object: String,
    pub pending_webhooks: i64,
    pub request: Option<Value>,
    pub type_: String,
}

Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object. For example, when a charge succeeds, we create a charge.succeeded event, and when an invoice payment attempt fails, we create an invoice.payment_failed event. Certain API requests might create multiple events. For example, if you create a new subscription for a customer, you receive both a customer.subscription.created event and a charge.succeeded event.

Events occur when the state of another API resource changes. The event’s data field embeds the resource’s state at the time of the change. For example, a charge.succeeded event contains a charge, and an invoice.payment_failed event contains an invoice.

As with other API resources, you can use endpoints to retrieve an individual event or a list of events from the API. We also have a separate webhooks system for sending the Event objects directly to an endpoint on your server. You can manage webhooks in your account settings. Learn how to listen for events so that your integration can automatically trigger reactions.

When using Connect, you can also receive event notifications that occur in connected accounts. For these events, there’s an additional account attribute in the received Event object.

We only guarantee access to events through the Retrieve Event API for 30 days.

Fields

account: Option<String>

The connected account that originates the event.

api_version: Option<String>

The Stripe API version used to render data. This property is populated only for events on or after October 31, 2014.

created: i64

Time at which the object was created. Measured in seconds since the Unix epoch.

data: NotificationEventData

id: String

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.

object: String

String representing the object’s type. Objects of the same type share the same value.

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<Value>

Information on the API request that triggers the event.

type_: String

Description of the event (for example, invoice.created or charge.refunded).

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Event

fn default() -> Event

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.