website logo
Channel Docs
Merchant Docs
Navigate through spaces
Channel Docs
Merchant Docs
⌘K
👋Welcome to Violet's Docs
💡Concepts
🚀Quick Start
🍎Create a Violet Application
😀Postman + Login
🏬View Merchants
👗Interact with Catalogs
🛍️Place an Order
🌐API Reference
✋Help
📝Changelog
Docs powered by archbee 
0min

Create Webhook

POST
Creates a new webhook for the desired event. The remote endpoint must be HTTPS.
QUERY PARAMETERS
app_idinteger
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
BODY PARAMETERS
body
Webhook
External Hook Event
idinteger<int32>
app_idinteger<int32>
eventstring<ORDER_UPDATED | ORDER_SHIPPED | ORDER_COMPLETED | ORDER_CANCELLED | ORDER_REFUNDED | ORDER_RETURNED | OFFER_CREATED | OFFER_UPDATED | OFFER_REMOVED>*
The event being triggered
remote_endpointstring*
Remote endpoint the webhook posts against.
statusstring<INACTIVE | ACTIVE | DISABLED>
Status of the webhook
date_createdstring<date-time>
Date of creation
date_last_modifiedstring<date-time>
Date of last update
RESPONSES
200
successful operation
Webhook
External Hook Event
idinteger<int32>
app_idinteger<int32>
eventstring<ORDER_UPDATED | ORDER_SHIPPED | ORDER_COMPLETED | ORDER_CANCELLED | ORDER_REFUNDED | ORDER_RETURNED | OFFER_CREATED | OFFER_UPDATED | OFFER_REMOVED>*
The event being triggered
remote_endpointstring*
Remote endpoint the webhook posts against.
statusstring<INACTIVE | ACTIVE | DISABLED>
Status of the webhook
date_createdstring<date-time>
Date of creation
date_last_modifiedstring<date-time>
Date of last update
Updated 21 Oct 2022
Did this page help you?
Yes
No
UP NEXT
Delete Channel Webhooks
Docs powered by archbee