Skip to main content

GET Webhook Filters

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 events.

GET Webhook Filters
MethodGET
URL or Endpoint/api/v1/projects/projectId/webhook-subscribers/subscriberId/events
HeadersAuthorization
ParameterssubscriberID, projectID
BodyNot Applicable

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
subscriberIDYesinteger($int32)Unique ID of the subscriber.
projectIDNostringUnique 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,
"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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false
errorsarray[string]Indicates if there was an error
messagesarray[string]Returns the response message from back-end
resultarray[Object]Returns the response object
idintegerThe id of the webhook filter.
webhookSubscriberIdintegerThe id of the webhook subscriber.
webhookEventIdintegerThe id of the webhook event.
WebhookSubscriberstringThe name of the corresponding webhook subscriber.
WebhookEventstringThe name of the corresponding webhook event.
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