action increase_list_events { label: "List Events" provider: increase method: GET path: "/events" encoding: json input: { type: "object" properties: { associated_object_id: { type: "string" description: "Filter Events to those belonging to the object with the provided identifier." } "category.in": { type: "array" description: "Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`." items: { type: "string" enum: ["account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "card.created", "card.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_wallet_token.created", "digital_wallet_token.updated", "document.created", "entity.created", "entity.updated", "external_account.created", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_wire_drawdown_request.created", "oauth_connection.created", "oauth_connection.deactivated", "pending_transaction.created", "pending_transaction.updated", "real_time_decision.card_authorization_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated"] } } "created_at.after": { type: "string" format: "date-time" description: "Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp." } "created_at.before": { type: "string" format: "date-time" description: "Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp." } "created_at.on_or_after": { type: "string" format: "date-time" description: "Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp." } "created_at.on_or_before": { type: "string" format: "date-time" description: "Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp." } cursor: { type: "string" description: "Return the page of entries after this one." } limit: { type: "integer" description: "Limit the size of the list that is returned. The default (and maximum) is 100 objects." } } additionalProperties: false } output: { type: "object" description: "A list of Event objects" required: ["data", "next_cursor"] properties: { data: { type: "array" description: "The contents of the list." items: { type: "object" description: "Events are records of things that happened to objects in the API. They also result in webhooks being generated." required: ["associated_object_id", "associated_object_type", "category", "created_at", "id", "type"] properties: { associated_object_id: { type: "string" description: "The identifier of the object that generated this Event." } associated_object_type: { type: "string" description: "The type of the object that generated this Event." } category: { type: "string" description: "The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully." enum: ["account.created", "account.updated", "account_number.created", "account_number.updated", "account_statement.created", "account_transfer.created", "account_transfer.updated", "ach_prenotification.created", "ach_prenotification.updated", "ach_transfer.created", "ach_transfer.updated", "card.created", "card.updated", "card_dispute.created", "card_dispute.updated", "check_deposit.created", "check_deposit.updated", "check_transfer.created", "check_transfer.updated", "declined_transaction.created", "digital_wallet_token.created", "digital_wallet_token.updated", "document.created", "entity.created", "entity.updated", "external_account.created", "file.created", "group.updated", "group.heartbeat", "inbound_ach_transfer_return.created", "inbound_ach_transfer_return.updated", "inbound_wire_drawdown_request.created", "oauth_connection.created", "oauth_connection.deactivated", "pending_transaction.created", "pending_transaction.updated", "real_time_decision.card_authorization_requested", "real_time_decision.digital_wallet_token_requested", "real_time_decision.digital_wallet_authentication_requested", "real_time_payments_transfer.created", "real_time_payments_transfer.updated", "real_time_payments_request_for_payment.created", "real_time_payments_request_for_payment.updated", "transaction.created", "wire_drawdown_request.created", "wire_drawdown_request.updated", "wire_transfer.created", "wire_transfer.updated"] } created_at: { type: "string" format: "date-time" description: "The time the Event was created." } id: { type: "string" description: "The Event identifier." } type: { type: "string" description: "A constant representing the object's type. For this resource it will always be `event`." enum: ["event"] } } } } next_cursor: { type: "string" description: "A pointer to a place in the list." } } } }