Rules

Use rules to automate. In the Rebilly rules engine, an action is an operation that executes when an event occurs. Action and event conditions are defined in rules. Rulesets are collections of rules that are associated with an event. The order in which the rules are placed within a ruleset specifies the execution order.

For a list of events and related actions, see Events.

Operations

Retrieve system events

Request

Retrieves a list of system events.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/events?limit=1000&offset=1000&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of system events retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
eventTypestring(EventType)read-only

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""coupon-application-removed""coupon-applied""coupon-expiration-modified""coupon-expired"
titlestring

Title of the system event.

descriptionstring

Description of the system event.

categorystring

Category of system event.

Enum:"billing""payments"
rulesCountintegerread-only

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.

bindsCountintegerread-only

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

]
Response
[
  {
    "eventType": "account-password-reset-requested",
    "title": "string",
    "description": "string",
    "category": "billing",
    "rulesCount": 0,
    "bindsCount": 0,
    "_links": [ … ]
  }
]