> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. For `account.passed` / `account.failed` the payload's `status` is overridden to the simulated outcome and `previousAttributes` carries 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:** ```json 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. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/organization/webhooks/{webhookId}/simulate openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/webhooks/{webhookId}/simulate: post: tags: - Webhooks summary: Simulate any event type (QA fixture) description: >- 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. For `account.passed` / `account.failed` the payload's `status` is overridden to the simulated outcome and `previousAttributes` carries 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:** ```json 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. operationId: postV1OrganizationWebhooksWebhookidSimulate parameters: - description: Webhook ID x-format: guid: true name: webhookId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Model758' responses: '200': description: Simulation result — check `delivered` field content: '*/*': schema: $ref: '#/components/schemas/Model760' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model47' '404': description: Webhook not found content: '*/*': schema: $ref: '#/components/schemas/Model368' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model758: type: object properties: eventType: $ref: '#/components/schemas/eventType' accountId: type: string description: >- Build the payload from this real account (read-only). Omit to use a static fixture. example: d290f1ee-6c54-4b01-90e6-d701748f0851 x-format: guid: true required: - eventType Model760: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model759' message: type: string example: Simulated event delivered successfully Model9: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model47: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model368: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Webhook not found code: type: string description: Machine-readable error code — switch on this, not on message text example: NOT_FOUND Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR eventType: type: string description: Event type to simulate example: account.failed enum: - 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 - purchase.created - purchase.status_changed - trader.created - snapshot.ready - fill.created - account.balance_changed Model759: type: object properties: delivered: type: boolean description: Whether your endpoint responded with a 2xx status example: true eventType: type: string description: The simulated event type that was sent example: account.failed httpStatus: type: number description: >- HTTP status code returned by your endpoint (null if connection failed) example: 200 error: type: string description: Error message if delivery failed responseTime: type: number description: Round-trip time in milliseconds example: 245 deliveryId: type: string description: >- Logged delivery ID; open it with GET /webhook-deliveries/{deliveryId} x-format: guid: true securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Real-time WebSocket for trading events](/trade-api/websocket/real-time-websocket-for-trading-events.md) - [Get order history (append-only lifecycle events)](/trade-api/orders/get-order-history-append-only-lifecycle-events.md) - [Webhooks](/guides/webhooks.md) - [Send a test event](/platform-api/webhooks/send-a-test-event.md) - [List all organization events](/platform-api/events/list-all-organization-events.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.