GET
/
events
/
webhooks
/
{webhook_id}
/
events
/
{event_id}

Headers

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

Path Parameters

webhook_id
integer
required
event_id
integer
required

Response

default - application/json

Webhook Event

status
enum<string>
required

Status of webhook event

Available options:
CREATED,
IN_PROGRESS,
SUCCEEDED,
FAILED,
CANCELLED
id
integer
app_id
integer

App ID

webhook_id
integer

ID of the webhook the event occurred on

entity_id
integer

ID of entity this event occurred for

entity_external_id
string

External ID of entity this event occurred for

status_code
integer

HTTP Status Code

response
string

Response from the remote url

event_type
enum<string>

Type of webhook event

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
remote_endpoint
string

Remote endpoint the webhook event was sent.

attempts
integer

Deliver attempts of the webhook the event

date_created
string

Date of creation

date_last_modified
string

Date of last update

date_next_attempt
string

Date of next delivery attempt

Was this page helpful?

Get Webhook EventsGet Webhook Event Body