PUT Webhook Subscriber

Overview

---

The following table contains important information about the PUT method in regards to putting a new webhook subscriber.

PUT Webhook Subscriber
Method	PUT
URL or Endpoint	/api/v1/projects/projectId/webhook-subscribers
Headers	Authorization
Parameters	projectId
Body	Check request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "id": 0,
  "url": "string",
  "name": "string",
  "description": "string",
  "active": true,
  "secret": "string"
}

Field Name	Type	Description
id	integer($int32)	The id of the webhook subscriber.
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	boolean	Indicates whether the webhook subscriber is active.
secret	string	Secret

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "id": 0,
    "url": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "secret": "string"
  },
  "resultInfo": "string",
  "statusCode": 0
}

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The id of the flag.
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	boolean	Indicates whether the webhook subscriber is active.
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