GET
/
events
/
webhooks
Header
Query
curl --request GET \
  --url https://sandbox-api.violet.io/v1/events/webhooks
[
  {
    "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
  }
]

Retrieve all webhooks that your app is subscribed to.

Headers

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

Query Parameters

app_id
integer
event
string
extended
boolean
default: false

Extends webhook to include 7-day stats

Response

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

The event being triggered

Available options:
ORDER_UPDATED,
ORDER_SHIPPED,
ORDER_COMPLETED,
ORDER_CANCELLED,
ORDER_REFUNDED,
ORDER_RETURNED,
OFFER_CREATED,
OFFER_UPDATED,
OFFER_REMOVED
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 events count

failure_rate
number

7-day events failure rate

Was this page helpful?

Merchants exploreCreate Webhook