2min
Get Webhook Event
GET
PATH PARAMETERS
webhook_idinteger*
event_idinteger*
QUERY PARAMETERS
app_idinteger
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
RESPONSES
200
successful operation
WebhookEvent
Webhook Event
idinteger<int32>
app_idinteger<int32>
App ID
webhook_idinteger<int32>
ID of the webhook the event occurred on
entity_idinteger<int64>
ID of entity this event occurred for
status_codeinteger<int32>
HTTP Status Code
responsestring
Response from the remote url
event_typestring<ORDER_UPDATED | ORDER_SHIPPED | ORDER_COMPLETED | ORDER_CANCELED | ORDER_REFUNDED | ORDER_RETURNED | MERCHANT_CONNECTED | MERCHANT_DISCONNECTED | OFFER_CREATED | OFFER_UPDATED | OFFER_REMOVED>
Type of webhook event
attemptsinteger<int32>
Deliver attempts of the webhook the event
statusstring<CREATED | IN_PROGRESS | SUCCEEDED | FAILED>*
Status of webhook event
date_createdstring<date-time>
Date of creation
date_last_modifiedstring<date-time>
Date of last update
Updated 03 Mar 2023
Did this page help you?
Yes
No