Retrieve webhook tracking logs

Request

Retrieves webhook tracking logs. Logs are sorted by creation time in descending order.
Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

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/tracking/webhooks?limit=0&offset=0&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Webhook tracking logs retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

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 [
idstring, <= 50 characters
ID of the webhook tracking log.
Example:"hook_log_01HXC7HJ1V2FNJD1R396WCG2HB"
statusinteger
Response code of the webhook request.
durationinteger
Duration of the webhook request in milliseconds.
initiatedTimestring, (date-time)(ServerTimestamp)read-only
Date and time when the webhook is initiated.
urlstring
URL that receives the webhook.
methodstring
HTTP method for sending the webhook.
Example:"POST"
requeststring
Payload of the webhook request.
responsestring
Response body from the webhook URL.
requestHeadersobject(HttpHeaders)
HTTP headers.
Example:
{ "Content-Type": "application/json", "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" }
responseHeadersobject(HttpHeaders)
HTTP headers.
Example:
{ "Content-Type": "application/json", "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" }
entityIdstring
ID of the main entity related to the event type.
organizationIdstring, <= 50 characters(OrganizationId)

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
eventTypeGlobalEventType (string) or string
Any of:
Type of event.
string(GlobalEventType)
Enum:"aml-list-possibly-matched""application-instance-disabled""application-instance-enabled""autodeposit-lookup-performed""balance-transaction-settled""coupon-application-removed""coupon-applied""coupon-expiration-modified""coupon-expired""coupon-issued"
sourcestring
Source that triggered the webhook.
Enum:"webhooks""rules"
attemptinteger
Number of attempts to send the webhook.
sentTimestring, (date-time)(ServerTimestamp)read-only
Date and time when the webhook is sent.
createdTimestring, (date-time)(CreatedTimeNoSort)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTimeNoSort)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
]
Response
[ { "id": "hook_log_01HXC7HJ1V2FNJD1R396WCG2HB", "status": 0, "duration": 0, "initiatedTime": "2019-08-24T14:15:22Z", "url": "string", "method": "POST", "request": "string", "response": "string", "requestHeaders": { … }, "responseHeaders": { … }, "entityId": "string", "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "eventType": "aml-list-possibly-matched", "source": "webhooks", "attempt": 0, "sentTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]