Get webhooks
GET /v2/webhook
GET
/v2/webhook
List all webhooks with pagination.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” page[number]
number
Page number (starts at 1)
Example
1 page[size]
number
Items per page
Example
10Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Responses
Section titled “ Responses ”List of webhooks.
object
items
required
List of webhooks
Array<object>
object
id
required
The webhook ID
string format: uuid
77a0049c-7683-45ff-956f-656f257048f7 name
The name of the webhook
string
Activate Payment Flow description
The description of the webhook
string
This webhook weill receive the notifications to trigger payments in our platform. url
required
The url of the webhook
string format: url
https://api.mycompany.com/webhooks/inbound enabledEvents
required
A list of event names that this webhook is configured to listen to (use ”*” for all events)
Array<string>
[ "*", "document.created", "document.scanned", "document.updated"] signingSecret
The secret used to sign the webhook payload
string
1234567890 status
The status of the webhook
string
active createdAt
The creation date
string format: date-time
2021-01-01T00:00:00.000Z lastTriggeredAt
The last triggered date
string format: date-time
2021-01-01T00:00:00.000Z 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