Skip to content

Get requests

GET
/v2/webhook/{webhookId}/requests

Get all requests for a webhook.

webhookId
required
string format: uuid

The ID of the webhook

Example
0ebec69f-cde5-4abf-83eb-595f8f023c80
page[number]
number

Page number (starts at 1)

Example
1
page[size]
number

Items per page

Example
10
X-API-Key
string

API Key

X-API-Secret
string

API Secret

List of webhook requests.

object
items
required

List of webhook requests

Array<object>
object
id
required

Record ID

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
notificationId
required

The notification ID

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
content
required

The payload to send to the webhook

object
status
required

The webhook status

string
Allowed values: pending success failed maxretriesexceeded cancelled
pending
lastAttempt
required

The last attempt date

string format: date-time
2021-01-01T00:00:00.000Z
retryCount
required

The retry count

number
4
createdAt
required

The creation date

string format: date-time
2021-01-01T00:00:00.000Z
logs
required

The webhook logs

Array<object>
object
id
required

Log ID

string format: uuid
0ebec69f-cde5-4abf-83eb-595f8f023c80
url
required

The webhook URL

string
https://api.example.com/webhook
content
required

The webhook content

object
status
required

The log status

string
Allowed values: sent success failed error
error
response

The response from the webhook

string
errorMessage

The error message

string
createdAt
required

The creation date

string format: date-time
2021-01-01T00:00:00.000Z
externalEventType
required

The external event type

string
document.updated
page
required

Object with the page number and the number of items per page

object
number
required

Page number (starts at 1)

number
1
size
required

Items per page

number
10
totalPages
required

Total number of items

number
100
totalCount
required

Total number of pages

number
10
hasNext
required

Whether there is a next page

boolean
true
hasPrev
required

Whether there is a previous page

boolean

Bad Request

Unauthorized

Forbidden

Not Found

Internal Server Error