POST
/
events
/
webhooks
curl --request POST \
  --url https://sandbox-api.violet.io/v1/events/webhooks \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "ORDER_UPDATED",
  "remote_endpoint": "<string>",
  "status": "INACTIVE"
}'
{
  "id": 123,
  "app_id": 123,
  "event": "ORDER_UPDATED",
  "remote_endpoint": "<string>",
  "status": "INACTIVE",
  "date_created": "2023-11-07T05:31:56Z",
  "date_last_modified": "2023-11-07T05:31:56Z",
  "events_count": 123,
  "failure_rate": 123,
  "temp_disable_ms": 123
}

Headers

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Body

application/json
event
enum<string>
required

The event being triggered

Available options:
ORDER_UPDATED,
ORDER_SHIPPED,
ORDER_COMPLETED,
ORDER_CANCELED,
ORDER_REFUNDED,
ORDER_RETURNED,
MERCHANT_CONNECTED,
MERCHANT_DISCONNECTED,
OFFER_CREATED,
OFFER_UPDATED,
OFFER_REMOVED,
PRODUCT_SYNC_STARTED,
PRODUCT_SYNC_COMPLETED,
PRODUCT_SYNC_FAILED,
MERCHANT_NEEDS_ATTENTION,
RELAY_OFFER_CREATED,
RELAY_OFFER_UPDATED,
RELAY_OFFER_REMOVED,
RELAY_ORDER_UPDATED,
MERCHANT_ENABLED,
MERCHANT_DISABLED,
MERCHANT_COMPLETE,
COLLECTION_CREATED,
COLLECTION_UPDATED,
COLLECTION_REMOVED,
COLLECTION_OFFERS_UPDATED,
COLLECTION_SYNC_STARTED,
COLLECTION_SYNC_COMPLETED,
COLLECTION_SYNC_FAILED
remote_endpoint
string
required

Remote endpoint the webhook posts against.

status
enum<string>

Status of the webhook

Available options:
INACTIVE,
ACTIVE,
DISABLED

Response

default - application/json
id
integer
app_id
integer
event
enum<string>
required

The event being triggered

Available options:
ORDER_UPDATED,
ORDER_SHIPPED,
ORDER_COMPLETED,
ORDER_CANCELED,
ORDER_REFUNDED,
ORDER_RETURNED,
MERCHANT_CONNECTED,
MERCHANT_DISCONNECTED,
OFFER_CREATED,
OFFER_UPDATED,
OFFER_REMOVED,
PRODUCT_SYNC_STARTED,
PRODUCT_SYNC_COMPLETED,
PRODUCT_SYNC_FAILED,
MERCHANT_NEEDS_ATTENTION,
RELAY_OFFER_CREATED,
RELAY_OFFER_UPDATED,
RELAY_OFFER_REMOVED,
RELAY_ORDER_UPDATED,
MERCHANT_ENABLED,
MERCHANT_DISABLED,
MERCHANT_COMPLETE,
COLLECTION_CREATED,
COLLECTION_UPDATED,
COLLECTION_REMOVED,
COLLECTION_OFFERS_UPDATED,
COLLECTION_SYNC_STARTED,
COLLECTION_SYNC_COMPLETED,
COLLECTION_SYNC_FAILED
remote_endpoint
string
required

Remote endpoint the webhook posts against.

status
enum<string>

Status of the webhook

Available options:
INACTIVE,
ACTIVE,
DISABLED
date_created
string

Date of creation

date_last_modified
string

Date of last update

events_count
integer

7 day event count

failure_rate
number

7 day failure rate

temp_disable_ms
integer

Temporary disable milliseconds

Was this page helpful?

Get WebhooksDelete Channel Webhooks