Retrieve tracking webhook notifications

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

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

Responses
200

Tracking webhook notifications 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
id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

eventType
string (EventType)

Rebilly event type.

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" … 52 more
entityId
string

ID of the main entity related to the event type.

url
string

URL where webhook is sent.

method
string

HTTP method used to send webhook.

object

HTTP headers used to send webhook.

property name*
additional property
string
responseCode
integer

HTTP code response.

responseBody
string

Response body received.

payload
string

Webhook payload.

source
string

Webhook source.

Enum: "webhooks" "rules"
attempt
integer

Webhook attempt number.

sentTime
string <date-time>

Sent time.

initiatedTime
string <date-time>

Initiated time.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/tracking/webhooks
Request samples
// all parameters are optional
const firstCollection = await api.tracking.getAllWebhookTrackingLogs();

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

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