Struct stripe::generated::event::Event

pub struct Event {
    pub id: EventId,
    pub account: Option<String>,
    pub api_version: Option<String>,
    pub created: Timestamp,
    pub data: NotificationEventData,
    pub livemode: bool,
    pub pending_webhooks: i64,
    pub request: Option<NotificationEventRequest>,
    pub type_: EventType,
}

The resource representing a Stripe “NotificationEvent”.

For more details see https://stripe.com/docs/api/events/object

Fields

id: EventId

Unique identifier for the object.

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: Timestamp

Time at which the object was created.

Measured in seconds since the Unix epoch.

data: NotificationEventData

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).

Implementations

impl Event

pub fn list(client: &Client, params: &ListEvents<'_>) -> Response<List<Event>>

List events, going back up to 30 days.

Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

pub fn retrieve( client: &Client, id: &EventId, expand: &[&str], ) -> Response<Event>

Retrieves the details of an event.

Supply the unique identifier of the event, which you might have received in a webhook.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy 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 Object for Event

type Id = EventId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

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.