Skip to main content

GET Webhook Subscribers


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 subscribers.

GET Webhook Subscribers
URL or Endpoint/api/v1/projects/projectId/webhook-subscribers
Parameterssearch, order, insertedDate, page, take, projectID
BodyNot Applicable

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
searchNostringText that is used for filtering.
orderNostringOrder by date or not.
insertedDateNostring($date-time)Date when the webhook was inserted.
pageNointeger($int32)A specific page with webhooks.
projectIDNostringUnique ID of the project.

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",
"description": "string",
"url": "string",
"active": true,
"secret": "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
idintegerWebhook Id
namestringThe name of the webhook subscriber
descriptionstringThe description of the webhook subscriber
urlstringThe url of the webhook subscriber
activeboolThe activity status of the webhook subsecriber
secretstringEnsures that the payload URL receives POST requests from GitHub.
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