Webhooks

List Webhook Logs

GET
Retrieves a paginated list of webhook logs that record historical attempts to send webhook payloads to a customer's servers. This endpoint allows filtering logs based on webhook type, creation timestamp range, retry attempts range, last response status, last retry timestamp range, and pagination settings. It is useful for auditing and debugging purposes.

Query parameters

webhookTypeenumOptional
The webhook type
retryAttemptsMinintegerOptional
The minimum retry attempts
retryAttemptsMaxintegerOptional
The maximum retry attempts
lastResponseStatusintegerOptional
The last response status
startLastRetryTimestampdatetimeOptional
The minimum last retry timestamp
endLastRetryTimestampdatetimeOptional
The maximum last retry timestamp
startTimestampdatetimeOptional
The minimum timestamp
endTimestampdatetimeOptional
The maximum timestamp (exclusive)
pageintegerOptional
The number of the page to retrieve (1 based)
sizeintegerOptional
The number of items per page

Response

This endpoint returns an object
content
list of objectsOptional
The content of the page, consisting of a list of objects.
page
integerOptional
The current page number. The first page has value 1.
size
integerOptional
The current page size. Default 15, maximum 250.
total
integerOptional
The number of objects matching the request.
first
booleanOptional
True if this is the first page, false otherwise.
last
booleanOptional
True if this is the last page, false otherwise.
GET
1curl -G https://app.impiloplatform.com/api/v3/webhook/logs \
2 -H "Impilo-API-Key: <apiKey>" \
3 --data-urlencode startLastRetryTimestamp=2022-03-10T16:15:50Z \
4 --data-urlencode endLastRetryTimestamp=2022-03-10T16:15:50Z \
5 --data-urlencode startTimestamp=2022-03-10T16:15:50Z \
6 --data-urlencode endTimestamp=2022-03-10T16:15:50Z
200Retrieved
1{
2 "content": [
3 {
4 "webhookId": 1,
5 "webhookType": "order.status",
6 "webhookUrl": "http://webhookserver.com",
7 "payload": "{'id':1234}",
8 "createTimestamp": "2023-08-22T14:15:30Z",
9 "lastResponseStatus": 200,
10 "retryAttempts": 3,
11 "lastRetryTimestamp": "2023-08-22T14:15:30Z"
12 }
13 ],
14 "page": 1,
15 "size": 1,
16 "total": 1,
17 "first": true,
18 "last": true
19}