GET Webhook Subscribers

Overview

---

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
Method	GET
URL or Endpoint	/api/v1/projects/projectId/webhook-subscribers
Headers	Authorization
Parameters	search, order, insertedDate, page, take, projectID
Body	Not Applicable

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	No	string	Text that is used for filtering.
order	No	string	Order by date or not.
insertedDate	No	string($date-time)	Date when the webhook was inserted.
page	No	integer($int32)	A specific page with webhooks.
projectID	No	string	Unique ID of the project.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "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 Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
currentPage	integer($int32)	Number of the current page
totalPages	integer($int32)	Number of the total page
pageSize	integer($int32)	The size of the page
totalCount	integer($int32)	Number of the total records
items	array[string]	Array with records
id	integer	Webhook Id
name	string	The name of the webhook subscriber
description	string	The description of the webhook subscriber
url	string	The url of the webhook subscriber
active	bool	The activity status of the webhook subsecriber
secret	string	Ensures that the payload URL receives POST requests from GitHub.
resultInfo	string	Returns extra information about the result
statusCode	integer($int32)	Returns the HTTP Status Code

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

Errors

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