Event

A recorded event and the resource snapshot associated with it. The snapshot preserves the payload version used when the event was created. Only pending_webhooks changes as webhook deliveries succeed.

The event's type identifies the change and determines the resource in data.object. See Event types for all event types that webhook endpoints can subscribe to and their payload resources.

  • id
    Type: string
    required

    Unique event ID. Use this value to retrieve the event through the Events API; it can differ from a webhook delivery's event ID.

  • created
    Type: stringFormat: date-time
    required

    Time the event was created, as an RFC 3339 timestamp. Fractional seconds may be included.

  • type
    Type: Event typeenum
    required

    Identifies the change recorded by the Event. See Event types for each type's trigger and resource snapshot.

    values
    • checkout_session.completed

      Sent when a Checkout Session has been completed.

    • payment.succeeded

      Sent when a payment has succeeded.

    • payment.failed

      Sent when a payment has failed.

    • payment_intent.authorized

      Sent when a Payment Intent has been authorized.

    • payment_intent.captured

      Sent when a Payment Intent has been captured.

    • account.created

      Sent when an account has been created.

    • account.updated

      Sent when an account has been updated.

    • account.capability.requested

      Sent when a capability has been requested for an account.

  • account
    Type: string
    required

    Account that produced the event. Receiving a connected account's webhook does not grant access to that account's event history.

  • api_version
    Type: string
    required

    Payload version used for the recorded resource snapshot. Retrieving the event does not convert it to another version.

  • livemode
    Type: boolean
    required

    Whether the event occurred in live mode (true) or test mode (false).

  • data
    required

    Resource snapshot and previous values associated with the event. Choose the resource indicated by type and the payload version indicated by api_version. The recorded snapshot can differ from the resource's current state.

    Event data for checkout_session.completed; api_version v2.

    • object
      Type: Checkout Session (v2)
      required

      Resource snapshot recorded when the event occurred.

      Properties: 14
    • previous_attributes
      Type: Previous attributes
      required

      Previous values for changed resource fields, or null when none are supplied. Keys correspond to fields in object and can include dotted paths for nested values.

      Properties: 1
  • pending_webhooks
    Type: integer
    min:  
    0
    required

    Number of webhook deliveries that have not succeeded. This includes failed deliveries whose retries have ended. A value of 0 means all associated deliveries succeeded or the event had no webhook destinations; it does not confirm payment or resource status.

  • request
    Type: Event request
    required

    Request associated with the event, or null when no request information is available.

    Properties: 2