1min

Create Webhook

POST
Creates a new webhook for the desired event. The remote endpoint must be HTTPS.

We currently limit webhooks to one per event per app. If the event is already active on a previously created webhook that existing webhook will be updated with the new endpoint.
PATH PARAMETERS
app_idinteger*
HEADER PARAMETERS
X-Violet-Tokenstring
X-Violet-App-Secretstring
X-Violet-App-Idinteger
BODY PARAMETERS
body
Webhook
External Hook Event
idinteger<int64>
app_idinteger<int64>
eventstring<order_updated | order_shipped | order_completed | order_canceled>
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 webhook creation
date_last_modifiedstring<date-time>
Date of last webhook update
RESPONSES
200
successful operation
Webhook
External Hook Event
idinteger<int64>
app_idinteger<int64>
eventstring<order_updated | order_shipped | order_completed | order_canceled>
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 webhook creation
date_last_modifiedstring<date-time>
Date of last webhook update
Updated 21 Apr 2022
Did this page help you?
Yes
No