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 Subscriber by Id
Method	GET
URL or Endpoint	/api/v1/projects/projectId/webhook-subscribers/id
Headers	Authorization
Parameters	id, projectID
Body	Not Applicable

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
id	Yes	integer($int32)	Unique Id.
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": {
    "id": 0,
    "url": "string",
    "name": "string",
    "description": "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
id	integer	Webhook Subscriber Id
url	string	The url of the webhook subscriber
name	string	The name of the webhook subscriber
description	string	The description 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