POST Webhook Filter

Overview

---

The following table contains important information about the POST method in regards to the managing process of adding a webhook filter

POST Webhook Filter
Method	POST
URL or Endpoint	/api/v1/projects/projectId/webhook-subscribers/subscriberId/events
Parameters	subscriberId, projectId
Body	Check the request body below.

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
subscriberId	Yes	integer($int32)	Unique Id of the subscriber.
projectId	No	string	Unique id of the project.

Request Body

[
  {
    "webhookEventId": 0
  }
]

Information about the fields that appear when you receive the response are displayed in the table below.

Parameter Name	Mandatory	Type	Description
webhookEventId	Yes	integer	Event Id

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": [
    {
      "id": 0,
      "webhookSubscriberId": 0,
      "webhookEventId": 0,
      "WebhookSubscriber": "string",
      "WebhookEvent": "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	The id of the webhook filter.
webhookSubscriberId	integer	The id of the webhook subscriber.
webhookEventId	integer	The id of the webhook event.
WebhookSubscriber	string	The name of the corresponding webhook subscriber.
WebhookEvent	string	The name of the corresponding webhook event.
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