logo

Retrieve system events

Retrieves a list of system events.

SecuritySecretApiKey or JWT
Responses
200

List of system events retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
eventType
string (EventType)

Type of Rebilly event.

Enum: "account-password-reset-requested" "account-verification-requested" "aml-list-possibly-matched" "application-instance-disabled" "application-instance-enabled" "balance-transaction-settled" "customer-created" "customer-one-time-password-requested" "dispute-created" "dispute-modified" … 55 more
title
string

Title of the system event.

description
string

Description of the system event.

category
string

Category of system event.

Enum: "billing" "payments"
rulesCount
integer

Total number of rules associated with the system event. A rule is a configuration of an event and one or more actions. A rule can be configured to stop subsequent rules in the event list from being executed.

bindsCount
integer

Total number of binds associated with the system event. A bind is a configuration of an event and one or more actions.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/events
Request samples 
// all parameters are optional
const firstCollection = await api.events.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100}; 
const secondCollection = await api.events.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(event => console.log(event.fields.eventType));
Response samples
application/json
[
  • {
    }
]
➔ Next to Retrieve event information