Create Webhook
2min
POST
AUTHENTICATION
Authorization
string
Bearer
QUERY PARAMETERS
app_id
integer
HEADER PARAMETERS
X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer
RESPONSES
200
successful operation
Webhook
External Hook Event
id
integer<int32>
app_id
integer<int32>
event
string<ORDER_UPDATED | ORDER_SHIPPED | ORDER_COMPLETED | ORDER_CANCELLED | ORDER_REFUNDED | ORDER_RETURNED | OFFER_CREATED | OFFER_UPDATED | OFFER_REMOVED>
*The event being triggered
remote_endpoint
string
*Remote endpoint the webhook posts against.
status
string<INACTIVE | ACTIVE | DISABLED>
Status of the webhook
date_created
string<date-time>
Date of creation
date_last_modified
string<date-time>
Date of last update
Updated 10 May 2023
Did this page help you?
Yes
No