POST
/
events
/
webhooks
/
all
/
events
/
search
curl --request POST \
  --url https://sandbox-api.violet.io/v1/events/webhooks/all/events/search \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    123
  ],
  "webhook_ids": [
    123
  ],
  "webhook_remote_endpoints": [
    "<string>"
  ],
  "status_codes": [
    123
  ],
  "statuses": [
    "CREATED"
  ],
  "event_types": [
    "ORDER_UPDATED"
  ],
  "entity_ids": [
    123
  ],
  "before_date": "2023-11-07T05:31:56Z",
  "after_date": "2023-11-07T05:31:56Z"
}'
{
  "content": [
    {
      "id": 123,
      "app_id": 123,
      "webhook_id": 123,
      "entity_id": 123,
      "entity_external_id": "<string>",
      "status_code": 123,
      "response": "<string>",
      "event_type": "ORDER_UPDATED",
      "remote_endpoint": "<string>",
      "attempts": 123,
      "status": "CREATED",
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z",
      "date_next_attempt": "2023-11-07T05:31:56Z"
    }
  ],
  "last": true,
  "total_pages": 123,
  "total_elements": 123,
  "first": true,
  "number_of_elements": 123,
  "size": 123,
  "number": 123,
  "empty": true,
  "next_page_cursor": "<string>",
  "pageable": {
    "page_number": 123,
    "page_size": 123,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 123,
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  }
}

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.

Headers

​
X-Violet-Token
string
​
X-Violet-App-Secret
string
​
X-Violet-App-Id
integer

Query Parameters

​
page
integer
default:1
​
size
integer
default:20

Body

application/json

Webhook Event Search Request

​
ids
integer[]

Webhook Event Ids

Webhook Event Ids

​
webhook_ids
integer[]

Webhook Ids

Webhook Ids

​
webhook_remote_endpoints
string[]

Webhook Remote Endpoints

Webhook Remote Endpoints

​
status_codes
integer[]

Http Status Codes

Http Status Codes

​
statuses
enum<string>[]

Statuses

Statuses

Available options:
CREATED,
IN_PROGRESS,
SUCCEEDED,
FAILED,
CANCELLED
​
event_types
enum<string>[]

Event Types

Event Types

Available options:
ORDER_UPDATED,
ORDER_SHIPPED,
ORDER_COMPLETED,
ORDER_CANCELED,
ORDER_REFUNDED,
ORDER_RETURNED,
MERCHANT_CONNECTED,
MERCHANT_DISCONNECTED,
OFFER_CREATED,
OFFER_UPDATED,
OFFER_REMOVED,
PRODUCT_SYNC_STARTED,
PRODUCT_SYNC_COMPLETED,
PRODUCT_SYNC_FAILED,
MERCHANT_NEEDS_ATTENTION,
RELAY_OFFER_CREATED,
RELAY_OFFER_UPDATED,
RELAY_OFFER_REMOVED,
RELAY_ORDER_UPDATED,
MERCHANT_ENABLED,
MERCHANT_DISABLED,
MERCHANT_COMPLETE,
COLLECTION_CREATED,
COLLECTION_UPDATED,
COLLECTION_REMOVED,
COLLECTION_OFFERS_UPDATED,
COLLECTION_SYNC_STARTED,
COLLECTION_SYNC_COMPLETED,
COLLECTION_SYNC_FAILED,
MERCHANT_PAYOUT_ACCOUNT_CREATED,
MERCHANT_PAYOUT_ACCOUNT_REQUIREMENTS_UPDATED
​
entity_ids
integer[]

Entity Ids

Entity Ids

​
before_date
string

Before Date

​
after_date
string

After Date

Response

default - application/json
default response
​
content
object[]

The actual content of the response; A list of the result objects

Webhook Event

​
last
boolean

Boolean indicating if this is the last page

​
total_pages
integer

The total count of pages available

​
total_elements
integer

The total count of objects available

​
first
boolean

Boolean indicating if this is the first page of the response

​
number_of_elements
integer

The total number of objects in this specific response

​
size
integer

The page size selected at request time

​
number
integer

The page number selected at request time

​
empty
boolean

Boolean indicating if the response content is empty

​
next_page_cursor
string

Contains the cursor for the next page. This property will only be used for situations where the API does not support the page number/page size paradigm and it will mutually exclusive with the size/number fields in the response. If this property is returned it must be passed when requesting the next page from the API. Does not apply to endpoints that do not have a next_page_cursor query param documented.

​
pageable
object

Violet wrapper for springframework pageable

​
sort
object

Violet Wrapper for springframework sort

Was this page helpful?