Simulate any event type (QA fixture)
Delivers a synthetic event of any real event type (account.passed,
account.failed, fill.created, …) to this webhook endpoint synchronously,
so you can test your full pass/breach/fill handling path deterministically —
no waiting for real trading activity.
Payload source — two modes:
- With
accountId— the payload is built from that real account’s current data (trader, plan, rule, purchase context included). The account is read-only: nothing about it is changed. Foraccount.passed/account.failedthe payload’sstatusis overridden to the simulated outcome andpreviousAttributescarries the real current status. - Without
accountId— a static, clearly-marked fixture account (SIM-FIXTURE-001,sim-trader@example.com) is used.
How to tell a simulated event apart: the payload always carries
"simulated": true at the top level. Real events never have this field.
Signature headers (X-Hyperprop-Signature etc.) are identical to production
deliveries, so your verification code path is exercised too.
Logging: the delivery is recorded under its real event type and is fully
inspectable via GET /webhook-deliveries/{deliveryId} (payload, response,
latency, attempts). Simulated deliveries never enter the automatic retry
schedule; use manual redelivery if needed.
Example:
POST /organization/webhooks/{webhookId}/simulate
{ "eventType": "account.failed", "accountId": "d290f1ee-6c54-4b01-90e6-d701748f0851" }
Permissions: requires manage access to “Webhooks”.
Authentication: send your organization API key in the X-API-Key header.
Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Webhooks.
curl --request POST \
--url https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"eventType": "account.failed",
"accountId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate"
payload = {
"eventType": "account.failed",
"accountId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({eventType: 'account.failed', accountId: 'd290f1ee-6c54-4b01-90e6-d701748f0851'})
};
fetch('https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'eventType' => 'account.failed',
'accountId' => 'd290f1ee-6c54-4b01-90e6-d701748f0851'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate"
payload := strings.NewReader("{\n \"eventType\": \"account.failed\",\n \"accountId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventType\": \"account.failed\",\n \"accountId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventType\": \"account.failed\",\n \"accountId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"delivered": true,
"eventType": "account.failed",
"httpStatus": 200,
"error": "<string>",
"responseTime": 245,
"deliveryId": "<string>"
},
"message": "Simulated event delivered successfully"
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "Webhook not found",
"code": "NOT_FOUND"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Headers
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
255Body
Event type to simulate
account.created, account.status_changed, account.updated, account.imported, account.passed, account.failed, account.lockout_created, account.lockout_removed, account.lockout_updated, account.payout_processed, account.max_payouts_reached, account.payout_reversed, account.time_limit_extended, account.daily_loss_limit_off, account.daily_loss_limit_on, account.claim_refused, purchase.created, purchase.status_changed, trader.created, snapshot.ready, fill.created, account.balance_changed, account.balance_adjusted, account.trading_day_reverted, account.trading_day_revert_undone "account.failed"
curl --request POST \
--url https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"eventType": "account.failed",
"accountId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate"
payload = {
"eventType": "account.failed",
"accountId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({eventType: 'account.failed', accountId: 'd290f1ee-6c54-4b01-90e6-d701748f0851'})
};
fetch('https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'eventType' => 'account.failed',
'accountId' => 'd290f1ee-6c54-4b01-90e6-d701748f0851'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate"
payload := strings.NewReader("{\n \"eventType\": \"account.failed\",\n \"accountId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventType\": \"account.failed\",\n \"accountId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}/simulate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventType\": \"account.failed\",\n \"accountId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"delivered": true,
"eventType": "account.failed",
"httpStatus": 200,
"error": "<string>",
"responseTime": 245,
"deliveryId": "<string>"
},
"message": "Simulated event delivered successfully"
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "Webhook not found",
"code": "NOT_FOUND"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}