StripeAPI.Types.Event

Contains the types generated from the schema Event

Documentation

data Event

Defines the object schema located at components.schemas.event in the specification.

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. Note that many API requests may cause multiple events to be created. For example, if you create a new subscription for a customer, you will receive both a `customer.subscription.created` event and a `charge.succeeded` event.

Events occur when the state of another API resource changes. The state of that resource at the time of the change is embedded in the event's data field. For example, a `charge.succeeded` event will contain a charge, and an `invoice.payment_failed` event will contain 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. Webhooks are managed in your account settings, and our Using Webhooks guide will help you get set up.

When using Connect, you can also receive notifications of events that occur in connected accounts. For these events, there will be an additional `account` attribute in the received `Event` object.

• *NOTE:** Right now, access to events through the Retrieve Event API is guaranteed only for 30 days.

Constructors

Event

Fields

• eventAccount :: Maybe Text

  account: The connected account that originated the event.

  Constraints:

  • Maximum length of 5000
• eventApiVersion :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• eventCreated :: Int

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

• eventData :: NotificationEventData

  data:

• eventId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• eventLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• eventPendingWebhooks :: Int

  pending_webhooks: Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.

• eventRequest :: Maybe EventRequest'

  request: Information on the API request that instigated the event.

• eventType :: Text

  type: Description of the event (e.g., `invoice.created` or `charge.refunded`).

  Constraints:

  • Maximum length of 5000

Instances

Eq Event

Defined in StripeAPI.Types.Event

Methods

(==) :: Event -> Event -> Bool

(/=) :: Event -> Event -> Bool

Show Event

Defined in StripeAPI.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

ToJSON Event

Defined in StripeAPI.Types.Event

Methods

toJSON :: Event -> Value

toEncoding :: Event -> Encoding

toJSONList :: [Event] -> Value

toEncodingList :: [Event] -> Encoding

FromJSON Event

Defined in StripeAPI.Types.Event

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

mkEvent

Arguments

:: Int

eventCreated

-> NotificationEventData

eventData

-> Text

eventId

-> Bool

eventLivemode

-> Int

eventPendingWebhooks

-> Text

eventType

-> Event

Create a new Event with all required fields.

data EventRequest'

Defines the object schema located at components.schemas.event.properties.request.anyOf in the specification.

Information on the API request that instigated the event.

Constructors

EventRequest'

Fields

• eventRequest'Id :: Maybe Text

  id: ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the dashboard, but currently not in the API.

  Constraints:

  • Maximum length of 5000
• eventRequest'IdempotencyKey :: Maybe Text

  idempotency_key: The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.

  Constraints:

  • Maximum length of 5000

Instances

Eq EventRequest'

Defined in StripeAPI.Types.Event

Methods

(==) :: EventRequest' -> EventRequest' -> Bool

(/=) :: EventRequest' -> EventRequest' -> Bool

Show EventRequest'

Defined in StripeAPI.Types.Event

Methods

showsPrec :: Int -> EventRequest' -> ShowS

show :: EventRequest' -> String

showList :: [EventRequest'] -> ShowS

ToJSON EventRequest'

Defined in StripeAPI.Types.Event

Methods

toJSON :: EventRequest' -> Value

toEncoding :: EventRequest' -> Encoding

toJSONList :: [EventRequest'] -> Value

toEncodingList :: [EventRequest'] -> Encoding

FromJSON EventRequest'

Defined in StripeAPI.Types.Event

Methods

parseJSON :: Value -> Parser EventRequest'

parseJSONList :: Value -> Parser [EventRequest']

mkEventRequest' :: EventRequest'

Create a new EventRequest' with all required fields.