Search All Webhook Events

Search and retrieve a list of WebhookEvents from all webhooks that you are subscribed to.

To avoid performance issues, total_elements and total_pages properties are not populated for this endpoint response, being both returned with default value of 0.

Search All Webhook Events

post

Search WebhookEvents from all Webhooks.

Query parameters

pageinteger · int32OptionalDefault: 1

sizeinteger · int32OptionalDefault: 20

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/json

Webhook Event Search Request

idsinteger · int32[]Optional

Webhook Event Ids

webhook_idsinteger · int32[]Optional

Webhook Ids

webhook_remote_endpointsstring[]Optional

Webhook Remote Endpoints

status_codesinteger · int32[]Optional

Http Status Codes

entity_idsinteger · int64[]Optional

Entity Ids

before_datestring · date-timeOptional

Before Date

after_datestring · date-timeOptional

After Date

Responses

default

default response

application/json

post

/events/webhooks/all/events/search

HTTPcURLJavaScriptPython

POST /v1/events/webhooks/all/events/search HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "ids": [
    1
  ],
  "webhook_ids": [
    1
  ],
  "webhook_remote_endpoints": [
    "text"
  ],
  "status_codes": [
    1
  ],
  "statuses": [
    "CREATED"
  ],
  "event_types": [
    "ORDER_UPDATED"
  ],
  "entity_ids": [
    1
  ],
  "before_date": "2025-12-19T00:13:29.735Z",
  "after_date": "2025-12-19T00:13:29.735Z"
}

default

default response

{
  "content": [
    {
      "id": 1,
      "app_id": 1,
      "webhook_id": 1,
      "entity_id": 1,
      "entity_external_id": "text",
      "status_code": 1,
      "response": "text",
      "event_type": "ORDER_UPDATED",
      "remote_endpoint": "text",
      "attempts": 1,
      "status": "CREATED",
      "date_created": "2025-12-19T00:13:29.735Z",
      "date_last_modified": "2025-12-19T00:13:29.735Z",
      "date_next_attempt": "2025-12-19T00:13:29.735Z"
    }
  ],
  "last": true,
  "total_pages": 1,
  "total_elements": 1,
  "first": true,
  "number_of_elements": 1,
  "size": 1,
  "number": 1,
  "empty": true,
  "next_page_cursor": "text",
  "pageable": {
    "page_number": 1,
    "page_size": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}