logo

Retrieve event information

Retrieves event information for a specified event type.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string

Type of event.

Responses
200

Rules retrieved.

Response Schema: application/json
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.

404

Resource not found.

get/events/{eventType}
Request samples 
const eventDetails = await api.events.get({eventType: 'gateway-account-created'});
console.log(eventDetails.fields.rulesCount);
Response samples
application/json
{
  • "eventType": "account-password-reset-requested",
  • "title": "string",
  • "description": "string",
  • "category": "billing",
  • "rulesCount": 0,
  • "bindsCount": 0,
  • "_links": [
    ]
}
➔ Next to Retrieve event rules