Search All Webhook Events - Violet Documentation

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:

size

integer

default:

Body

application/json

Webhook Event Search Request

after_date

string

After Date

before_date

string

Before Date

entity_ids

integer[]

Entity Ids

event_types

enum<string>[]

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

ids

integer[]

Webhook Event Ids

status_codes

integer[]

Http Status Codes

statuses

enum<string>[]

Statuses

Available options:

CREATED,

IN_PROGRESS,

SUCCEEDED,

FAILED,

CANCELLED

webhook_ids

integer[]

Webhook Ids

webhook_remote_endpoints

string[]

Webhook Remote Endpoints

Response

default - application/json

content

object[]

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

empty

boolean

Boolean indicating if the response content is empty

first

boolean

Boolean indicating if this is the first page of the response

last

boolean

Boolean indicating if this is the last page

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.

number

integer

The page number selected at request time

number_of_elements

integer

The total number of objects in this specific response

pageable

object

Violet wrapper for springframework pageable

size

integer

The page size selected at request time

sort

object

Violet Wrapper for springframework sort

total_elements

integer

The total count of objects available

total_pages

integer

The total count of pages available