Search Webhook Events
curl --request POST \
--url https://sandbox-api.violet.io/v1/events/webhooks/all/events/search \
--header 'Content-Type: application/json' \
--data '{
"ids": [
123
],
"webhookIds": [
123
],
"webhookRemoteEndpoints": [
"<string>"
],
"statusCodes": [
123
],
"statuses": [
"IN_PROGRESS"
],
"eventTypes": [
"ORDER_UPDATED"
],
"beforeDate": "2023-11-07T05:31:56Z",
"afterDate": "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",
"attempts": 123,
"status": "IN_PROGRESS",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "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>"
}
Search and retrieve a list of WebhookEvent
s 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
Query Parameters
Body
IN_PROGRESS
, SUCCEEDED
, FAILED
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
Response
The actual content of the response; A list of the result objects
Boolean indicating if this is the last page
The total count of pages available
The total count of objects available
Boolean indicating if this is the first page of the response
The total number of objects in this specific response
The page size selected at request time
The page number selected at request time
Boolean indicating if the response content is empty
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.
Was this page helpful?
curl --request POST \
--url https://sandbox-api.violet.io/v1/events/webhooks/all/events/search \
--header 'Content-Type: application/json' \
--data '{
"ids": [
123
],
"webhookIds": [
123
],
"webhookRemoteEndpoints": [
"<string>"
],
"statusCodes": [
123
],
"statuses": [
"IN_PROGRESS"
],
"eventTypes": [
"ORDER_UPDATED"
],
"beforeDate": "2023-11-07T05:31:56Z",
"afterDate": "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",
"attempts": 123,
"status": "IN_PROGRESS",
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "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>"
}