Skip to main content

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
MethodPUT
URL or Endpoint/api/v1/projects/projectId/webhook-subscribers
HeadersAuthorization
ParametersprojectId
BodyCheck request body below.

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"id": 0,
"url": "string",
"name": "string",
"description": "string",
"active": true,
"secret": "string"
}
Field NameTypeDescription
idinteger($int32)The id of the webhook subscriber.
urlstringThe url of the webhook subscriber.
namestringThe name of the webhook subscriber.
descriptionstringThe description of the webhook subscriber.
activebooleanIndicates whether the webhook subscriber is active.
secretstringSecret

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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the flag.
urlstringThe url of the webhook subscriber.
namestringThe name of the webhook subscriber.
descriptionstringThe description of the webhook subscriber.
activebooleanIndicates whether the webhook subscriber is active.
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.

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