List Events
Intent
Reads the available events as a pageable collection without changing them.
When to call it
Call this when an interface, sync, or support workflow needs to inspect events. Use the filters and paging controls shown below to limit the result.
Access boundary
Authorize the request with a token that carries events:read or events:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Query Parameters
Parameter: Filter events following filter clauses. JSON string following the same schema a meter filter clause.
Parameter: Filter events after this timestamp.
Parameter: Filter events before this timestamp.
Return only records matching organization ID. Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Return only records matching customer ID. Identifier of the customer.
Return only records matching external customer ID.
Return only records matching a meter filter clause. Identifier of the meter.
Return only records matching event name.
Return only records matching event source.
system, user Parameter: Query to filter events.
Parameter: When combined with depth, use this event as the anchor instead of root events. Identifier of the event.
Parameter: Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.
0 <= x <= 5Results page to return. The first page is used by default.
Records returned per page. Defaults to 10 and accepts up to 100.
Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.
timestamp, -timestamp Return only records matching metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
Response
Request completed successfully
- ListResource[Event]
- ListResourceWithCursorPagination[Event]
Object representing event created by Ruba when credits are added to a customer meter.
- MeterCreditEvent
- MeterResetEvent
- BenefitGrantedEvent
- BenefitCycledEvent
- BenefitUpdatedEvent
- BenefitRevokedEvent
- SubscriptionCreatedEvent
- SubscriptionUpdatedEvent
- SubscriptionCycledEvent
- SubscriptionCanceledEvent
- SubscriptionRevokedEvent
- SubscriptionPastDueEvent
- SubscriptionReactivatedEvent
- SubscriptionUncanceledEvent
- SubscriptionProductUpdatedEvent
- SubscriptionSeatsUpdatedEvent
- SubscriptionBillingPeriodUpdatedEvent
- SubscriptionUpdateClearedEvent
- OrderPaidEvent
- OrderRefundedEvent
- OrderVoidedEvent
- CheckoutCreatedEvent
- CustomerCreatedEvent
- CustomerUpdatedEvent
- CustomerDeletedEvent
- BalanceOrderEvent
- BalanceCreditOrderEvent
- BalanceRefundEvent
- BalanceRefundReversalEvent
- BalanceDisputeEvent
- BalanceDisputeReversalEvent
- UserEvent