Events
Returns events generated by account activity, including the event type, associated object, and request details.
View-Specific Information
SELECT
The add-in uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
| Column | Supported Operators |
| Id | = |
| Type | = |
| AccountId | = |
| Created | <, >, >=, <, <=, = |
You can select:
- An event by specifying its Id:
SELECT * FROM Events WHERE Id = 'dp_12345678'
- Events that happened after a specific date:
SELECT * FROM Events WHERE Created > '2018-01-01'
- Created can also be used twice to specify a range:
SELECT * FROM Events WHERE Created >= '2018-01-01 00:00:00.0' AND Created <= '2018-12-31 23:59:59.0'
- Created can also be used twice to specify a range:
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the event. | |
| ApiVersion | String | The Stripe API version used to render the event data. | |
| Created | Datetime | The date and time at which the event was created. | |
| ObjectId | String | The Id of the object associated with the event. | |
| ObjectName | String | The name of the object for which the event occurred. | |
| Livemode | Boolean | Indicates whether the event is in live mode. | |
| PendingWebhooks | Integer | The number of webhooks that have not yet been delivered successfully, meaning they have not returned a 20x response, to the URLs you have specified. | |
| RequestId | String | The Id of the API request that caused the event. | |
| RequestIdempotencyKey | String | The idempotency key transmitted during the request, if any. This property is populated only for events on or after May 23, 2017. | |
| Type | String | The type of the event, which describes the kind of activity that occurred. | |
| Description | String | An arbitrary string attached to the object, often useful for displaying to users. The description field on invoice line items has a maximum length of 500 characters. | |
| PreviousAttributes | String | The object containing the names of the attributes that have changed. | |
| DataObject | String | The object containing the API resource relevant to the event. | |
| DataObjectAmount | Integer | The amount associated with the event data object. | |
| DataObjectAmountCapturable | Integer | The amount that can be captured for the event data object. | |
| DataObjectAmountDetails | String | The amount details for the event data object. | |
| DataObjectAmountReceived | Integer | The amount received for the event data object. | |
| DataObjectApplication | String | The application associated with the event data object. | |
| DataObjectApplicationFeeAmount | String | The application fee amount for the event data object. | |
| DataObjectAutomaticPaymentMethods | String | The automatic payment methods configured for the event data object. | |
| DataObjectCanceledAt | Datetime | The date and time at which the event data object was canceled. | |
| DataObjectCancellationReason | String | The reason the event data object was canceled. | |
| DataObjectCaptureMethod | String | The capture method used for the event data object. | |
| DataObjectClientSecret | String | The client secret of the event data object. | |
| DataObjectConfirmationMethod | String | The confirmation method used for the event data object. | |
| DataObjectCreated | Datetime | The date and time at which the event data object was created. | |
| DataObjectCurrency | String | The currency code of the event data object. | |
| DataObjectCustomer | String | The Id of the customer associated with the event data object. | |
| DataObjectDescription | String | The description of the event data object. | |
| DataObjectInvoice | String | The Id of the invoice associated with the event data object. | |
| DataObjectLastPaymentError | String | The last payment error for the event data object. | |
| DataObjectLatestCharge | String | The latest charge for the event data object. | |
| DataObjectLivemode | Boolean | Indicates whether the event data object is in live mode. | |
| DataObjectMetadata | String | The set of key-value pairs attached to the event data object. | |
| DataObjectNextAction | String | The next action details for the event data object. | |
| DataObjectOnBehalfOf | String | The account on whose behalf the event data object was created. | |
| DataObjectPaymentMethod | String | The payment method used for the event data object. | |
| DataObjectPaymentMethodConfigurationDetails | String | The payment method configuration details for the event data object. | |
| DataObjectPaymentMethodOptions | String | The payment method options for the event data object. | |
| DataObjectPaymentMethodTypes | String | The payment method types for the event data object. | |
| DataObjectProcessing | String | The processing details for the event data object. | |
| DataObjectReceiptEmail | String | The receipt email for the event data object. | |
| DataObjectReview | String | The review associated with the event data object. | |
| DataObjectSetupFutureUsage | String | The setup future usage setting for the event data object. | |
| DataObjectShipping | String | The shipping details for the event data object. | |
| DataObjectSource | String | The source of the event data object. | |
| DataObjectStatementDescriptor | String | The statement descriptor for the event data object. | |
| DataObjectStatementDescriptorSuffix | String | The statement descriptor suffix for the event data object. | |
| DataObjectStatus | String | The status of the event data object. | |
| DataObjectTransferData | String | The transfer data for the event data object. | |
| DataObjectTransferGroup | String | The transfer group for the event data object. | |
| Context | String | The Stripe business or account context in which the event occurred. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AccountId | String | The Id of the connected account from which to retrieve events. |