Read Event
Intent
Reads the event without changing it.
When to call it
Call this after your application has received or stored the identifier for the event.
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
Path Parameters
Identifier of the event.
Response
Request completed successfully
- 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
Object representing event created by Ruba when credits are added to a customer meter.
The stable identifier for this record.
Time at which the event occurred.
Unique identifier for the organization owning the event.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Identifier of the customer in your Ruba organization associated with the event.
Customer record connected to this event.
- CustomerIndividual
- CustomerTeam
Your system identifier for the customer connected to this event.
Readable label describing the event type.
Source: Source of the event. system events are created by Ruba. user events are the one you create through our ingestion API.
"system"Name assigned to the event.
"meter.credited"Identifier of the member within the customer's organization who performed the action inside B2B.
Identifier of the member in your system within the customer's organization who performed the action inside B2B.
Count of direct child events linked to this event.
Unique identifier for the parent event.