Skip to main content

GET Webhook Events


The following table contains information about the GET method in regards to the managing process, more precisely when you want to make a GET request that returns all the webhook events.

GET Webhook Events
URL or Endpoint/api/v1/webhook-events
Parameterssearch, page, take, order, insertedDate
BodyNot Applicable

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
searchNostringText that is used for filtering.
pageNointeger($int32)A specific page with webhook events.
takeNostringNumber of webhook events to take.
orderNostringOrder by date or not.
insertedDateNoDateDate when the webhook event was inserted.

Request Body

The GET method doesn't contain a request body.


"success": true,
"errors": [
"messages": [
"result": {
"currentPage": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"items": [
"id": 0,
"name": "string",
"group": "string"
"resultInfo": "string",
"statusCode": 0

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false
errorsarray[string]Indicates if there was an error
messagesarray[string]Returns the response message from back-end
resultarray[Object]Returns the response object
currentPageinteger($int32)Number of the current page
totalPagesinteger($int32)Number of the total page
pageSizeinteger($int32)The size of the page
totalCountinteger($int32)Number of the total records
itemsarray[string]Array with records
idintegerThe id of the webhook event
namestringThe name of the webhook event
groupstringThe group of the webhook event
resultInfostringReturns extra information about the result
statusCodeinteger($int32)Returns the HTTP Status Code

If the action is successful, the service sends back an HTTP 200 or 201 response.


For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed