GET

/v1/events/webhooks/{webhook_id}/events

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
curl --request GET \
  --url https://sandbox-api.violet.io/v1/events/webhooks/{webhook_id}/events
{
  "app_id": "integer",
  "attempts": "integer",
  "date_created": "string",
  "date_last_modified": "string",
  "entity_external_id": "string",
  "entity_id": "integer",
  "event_type": "ORDER_UPDATED",
  "id": "integer",
  "response": "string",
  "status": "CREATED",
  "status_code": "integer",
  "webhook_id": "integer"
}

Retrieve a list of WebhookEvents for a single webhook that you are subscribed to, given the webhook_id.

Headers

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

Path Parameters

webhook_idrequired
integer

Query Parameters

app_id
integer
since
integer
page
Default: "1"
integer
size
Default: "20"
integer

Response

200 - application/json
app_id
integer

App ID

attempts
integer

Deliver attempts of the webhook the event

date_created
string

Date of creation

date_last_modified
string

Date of last update

entity_external_id
string

External ID of entity this event occurred for

entity_id
integer

ID of entity this event occurred for

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
id
integer
response
string

Response from the remote url

statusrequired
enum<string>

Status of webhook event

Available options:
CREATED,
IN_PROGRESS,
SUCCEEDED,
FAILED
status_code
integer

HTTP Status Code

webhook_id
integer

ID of the webhook the event occurred on

Get Webhook Event TypesGet Webhook Event