Simulate Webhook Event

Simulate Webhook Event

post

Simulates a webhook event for testing purposes. A webhook event will be created and delivered to the remote endpoint of the webhook.

Path parameters
app_idinteger · int32Required
webhook_idinteger · int32Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body

Request body for webhook simulator

order_idinteger · int64Optional

Order ID to be used on simulation

offer_idinteger · int64Optional

Offer ID to be used on simulation

collection_idinteger · int64Optional

Collection ID to be used on simulation

merchant_idinteger · int32Optional

Merchant ID to be used on simulation

Responses
default
default response
application/json
post
POST /v1/apps/{app_id}/webhooks/{webhook_id}/simulate 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: 61

{
  "order_id": 1,
  "offer_id": 1,
  "collection_id": 1,
  "merchant_id": 1
}
default

default response

No content

Last updated

Was this helpful?