Create Webhook
Creates a new webhook for the desired event. The remote endpoint must be HTTPS.
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
External Hook Event
idinteger · int32Read-onlyOptional
app_idinteger · int32Read-onlyOptional
eventstring · enumRequiredPossible values:
The event being triggered
remote_endpointstringRequired
Remote endpoint the webhook posts against.
statusstring · enumOptionalPossible values:
Status of the webhook
date_createdstring · date-timeRead-onlyOptional
Date of creation
date_last_modifiedstring · date-timeRead-onlyOptional
Date of last update
events_countinteger · int64Read-onlyOptional
7 day event count
failure_ratenumber · doubleRead-onlyOptional
7 day failure rate
temp_disable_msinteger · int64Read-onlyOptional
Temporary disable milliseconds
Responses
default
default response
application/json
post
POST /v1/events/webhooks HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"event": "ORDER_UPDATED",
"remote_endpoint": "text",
"status": "INACTIVE"
}
default
default response
{
"id": 1,
"app_id": 1,
"event": "ORDER_UPDATED",
"remote_endpoint": "text",
"status": "INACTIVE",
"date_created": "2025-07-10T01:20:40.861Z",
"date_last_modified": "2025-07-10T01:20:40.861Z",
"events_count": 1,
"failure_rate": 1,
"temp_disable_ms": 1
}
Last updated
Was this helpful?